Created
July 20, 2016 18:25
-
-
Save buttreygoodness/987041a4d03becd99b161f8ad4fff110 to your computer and use it in GitHub Desktop.
Swag
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "version": "1.0.0", | |
| "title": "RLBPulse API", | |
| "description": "## Structure\n\n### The Envelope\nEvery response is contained by an envelope. That is, each response has a\npredictable set of keys with which you can expect to interact:\n```json\n{\n \"meta\": {\n \"code\": 200\n },\n \"data\": {\n ...\n }\n}\n```\n\n### META\nThe meta key is used to communicate extra information about the response to\nthe developer. If all goes well, you'll only ever see a code key with value 200. However, sometimes things go wrong, and in that case you might see a\nresponse like:\n```json\n{\n \"meta\": {\n \"error_type\": \"OAuthException\",\n \"code\": 400,\n \"error_message\": \"...\"\n }\n}\n```\n\n### DATA\nThe data key is the meat of the response. It may be a list or dictionary,\nbut either way this is where you'll find the data you requested.\n\n## Deleting Objects\nWe do our best to have all our URLs be\n[RESTful](http://en.wikipedia.org/wiki/Representational_state_transfer).\nEvery endpoint (URL) may support one of four different http verbs. GET\nrequests fetch information about an object, POST requests create objects,\nPUT requests update objects, and finally DELETE requests will delete\nobjects.\n\nSince many old browsers don't support PUT or DELETE, we've made it easy to\nfake PUTs and DELETEs. All you have to do is do a POST with _method=PUT or\n_method=DELETE as a parameter and we will treat it as if you used PUT or\nDELETE respectively.\n", | |
| "termsOfService": "http://rlbpulse.com/terms/", | |
| "contact": { | |
| "name": "RLBPulse Team", | |
| "email": "[email protected]", | |
| "url": "http://rlbpulse.com" | |
| }, | |
| "license": { | |
| "name": "Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License", | |
| "url": "http://creativecommons.org/licenses/by-nc-nd/4.0/" | |
| } | |
| }, | |
| "host": "apidev.rlbpulse.com", | |
| "basePath": "/api", | |
| "schemes": [ | |
| "http" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "paths": { | |
| "/lead": { | |
| "get": { | |
| "tags": [ | |
| "lead" | |
| ], | |
| "summary": "Get a Lead template (with enums)", | |
| "description": "Gets a new Lead template", | |
| "operationId": "getLead", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "LeadEnums response", | |
| "schema": { | |
| "$ref": "#/definitions/LeadEnums" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "lead" | |
| ], | |
| "summary": "Create a new lead", | |
| "description": "Adds a new lead to the system", | |
| "operationId": "createLead", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Project object that to create", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/PutProject" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Project response", | |
| "schema": { | |
| "$ref": "#/definitions/Project" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/lead/{prjct_id}": { | |
| "get": { | |
| "tags": [ | |
| "lead" | |
| ], | |
| "summary": "Retrieve a lead", | |
| "description": "Retrieves a lead by ID", | |
| "operationId": "getLeadByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of lead to retrieve", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Project response", | |
| "schema": { | |
| "$ref": "#/definitions/Project" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "lead" | |
| ], | |
| "summary": "Update a lead", | |
| "description": "Updates a lead by ID", | |
| "operationId": "updateLeadByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of lead to update", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Updated Project object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/PutProject" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Project response", | |
| "schema": { | |
| "$ref": "#/definitions/Project" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/lead/{prjct_id}/close": { | |
| "put": { | |
| "tags": [ | |
| "lead" | |
| ], | |
| "summary": "Closes a lead", | |
| "description": "Closes a lead by ID", | |
| "operationId": "closeLeadByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of lead to close", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Updated Project object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/PutProject" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Project response", | |
| "schema": { | |
| "$ref": "#/definitions/Project" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/lead/{prjct_id}/reopen": { | |
| "put": { | |
| "tags": [ | |
| "lead" | |
| ], | |
| "summary": "Reopen a lead", | |
| "description": "Reopens a lead by ID", | |
| "operationId": "reopenLeadByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of lead to reopen", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Updated Project object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/PutProject" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Project response", | |
| "schema": { | |
| "$ref": "#/definitions/Project" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/lead/{prjct_id}/convert": { | |
| "put": { | |
| "tags": [ | |
| "lead" | |
| ], | |
| "summary": "Convert a lead", | |
| "description": "Converts a lead by ID", | |
| "operationId": "convertLeadByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of lead to convert", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Updated Project object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/PutProject" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Project response", | |
| "schema": { | |
| "$ref": "#/definitions/Project" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/lead/{prjct_id}/version": { | |
| "put": { | |
| "tags": [ | |
| "lead" | |
| ], | |
| "summary": "Version a lead", | |
| "description": "Versions a lead by ID", | |
| "operationId": "versionLeadByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of lead to version", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Updated Project object", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/PutProject" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Project response", | |
| "schema": { | |
| "$ref": "#/definitions/Project" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/configurations": { | |
| "get": { | |
| "tags": [ | |
| "configurations" | |
| ], | |
| "summary": "Retrieve a Project's Configurations", | |
| "description": "Retrieves Configurations by a Project ID", | |
| "operationId": "getConfigurationsByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for Configurations", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Configurations response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectConfiguration" | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "configurations" | |
| ], | |
| "summary": "Create a Project Configuration", | |
| "description": "Creates Project Configuration by a Project ID", | |
| "operationId": "createConfigurationByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for Configurations", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Configuration object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectConfiguration" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Configuration response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectConfiguration" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/configurations/{prjcf_id}": { | |
| "get": { | |
| "tags": [ | |
| "configurations" | |
| ], | |
| "summary": "Retrieve a Project Configuration", | |
| "description": "Retrieves Configuration by ConfigurationID", | |
| "operationId": "getConfigurationByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjcf_id", | |
| "description": "ID of Project Configuration", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Configuration response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectConfiguration" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "configurations" | |
| ], | |
| "summary": "Update a Project Configuration", | |
| "description": "Updates Configuration by ConfigurationID", | |
| "operationId": "updateConfigurationByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjcf_id", | |
| "description": "ID of Project Configuration", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Configuration object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectConfiguration" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Configuration response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectConfiguration" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "configurations" | |
| ], | |
| "summary": "Delete a Project Configuration", | |
| "description": "Deletes Configuration by ConfigurationID", | |
| "operationId": "deleteConfigurationByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjcf_id", | |
| "description": "ID of Project Configuration", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Configuration response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectConfiguration" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/contributors": { | |
| "get": { | |
| "tags": [ | |
| "contributors" | |
| ], | |
| "summary": "Retrieve a Project's Contributors", | |
| "description": "Retrieves Contributors by a Project ID", | |
| "operationId": "getContributorsByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of project for contributors", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Contributors response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectContributor" | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "contributors" | |
| ], | |
| "summary": "Create a Project Contributor", | |
| "description": "Creates Contributor by a Project ID", | |
| "operationId": "createContributorByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of project for contributors", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Contributor object for createion", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectContributor" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Contributor response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectContributor" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/contributors/{prjcn_id}": { | |
| "get": { | |
| "tags": [ | |
| "contributors" | |
| ], | |
| "summary": "Retrieve a Project Contributor", | |
| "description": "Retrieves Contributor by ContributorID", | |
| "operationId": "getContributorByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjcn_id", | |
| "description": "ID of Contributor", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Contributor response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectContributor" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "contributors" | |
| ], | |
| "summary": "Update a Project Contributor", | |
| "description": "Updates Contributor by ContributorID", | |
| "operationId": "updateContributorByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjcn_id", | |
| "description": "ID of Contributor", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Contributor object for update", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectContributor" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Contributor response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectContributor" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "contributors" | |
| ], | |
| "summary": "Delete a Project Contributor", | |
| "description": "Deletes Contributor by ContributorID", | |
| "operationId": "deleteContributorByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjcn_id", | |
| "description": "ID of Contributor", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Contributor response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectContributor" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/appendicies": { | |
| "get": { | |
| "tags": [ | |
| "appendicies" | |
| ], | |
| "summary": "Retrieve a Project's Appendicies", | |
| "description": "Retrieves Appendicies by a Project ID", | |
| "operationId": "getAppendiciesByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for Appendicies", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Appendicies response", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectAppendix" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "appendicies" | |
| ], | |
| "summary": "Create a Project Appendix", | |
| "description": "Creates Appendicix by a Project ID", | |
| "operationId": "createAppendixByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for Appendicies", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Appendix object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectAppendix" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Appendix response", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/ProjectAppendix" | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "appendicies" | |
| ], | |
| "summary": "Delete all project appendicies", | |
| "description": "Deletes project appendicies by a Project ID", | |
| "operationId": "deleteAppendiciesByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for Appendicies", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Appendicies response", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/ProjectAppendix" | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/appendicies/{prjap_id}": { | |
| "get": { | |
| "tags": [ | |
| "appendicies" | |
| ], | |
| "summary": "Retrieve a Project Appendix", | |
| "description": "Retrieves Appendix by appendixID", | |
| "operationId": "getAppendixByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjap_id", | |
| "description": "ID of Appendix", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Appendix response", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/ProjectAppendix" | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "appendicies" | |
| ], | |
| "summary": "Update a Project Appendix", | |
| "description": "Updates Appendix by appendixID", | |
| "operationId": "updateAppendixByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjap_id", | |
| "description": "ID of Appendix", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Appendix object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectAppendix" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Appendix response", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/ProjectAppendix" | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "appendicies" | |
| ], | |
| "summary": "Delete a Project Appendix", | |
| "description": "Deletes Appendix by appendixID", | |
| "operationId": "deleteAppendixByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjap_id", | |
| "description": "ID of Appendix", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Appendix response", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/definitions/ProjectAppendix" | |
| } | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/elements": { | |
| "get": { | |
| "tags": [ | |
| "elements" | |
| ], | |
| "summary": "Retrieve a Project's Elements", | |
| "description": "Retrieves Elements by a Project ID", | |
| "operationId": "getElementsByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for Elements", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Elements response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectElement" | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "elements" | |
| ], | |
| "summary": "Create a Project Element", | |
| "description": "Creates Project Element by a Project ID", | |
| "operationId": "createElementByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for Elements", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Element object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectElement" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Element response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectElement" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/elements/{prjel_id}": { | |
| "get": { | |
| "tags": [ | |
| "elements" | |
| ], | |
| "summary": "Retrieve a Project Element", | |
| "description": "Retrieves Element by ElementID", | |
| "operationId": "getElementByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjel_id", | |
| "description": "ID of Project Element", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Element response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectElement" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "elements" | |
| ], | |
| "summary": "Update a Project Element", | |
| "description": "Updates Element by ElementID", | |
| "operationId": "updateElementByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjel_id", | |
| "description": "ID of Project Element", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Element object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectElement" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Element response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectElement" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "elements" | |
| ], | |
| "summary": "Delete a Project Element", | |
| "description": "Deletes Element by ElementID", | |
| "operationId": "deleteElementByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjel_id", | |
| "description": "ID of Project Element", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Element response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectElement" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/exceptions": { | |
| "get": { | |
| "tags": [ | |
| "exceptions" | |
| ], | |
| "summary": "Retrieve a Project's Exceptions", | |
| "description": "Retrieves Exceptions by a Project ID", | |
| "operationId": "getExceptionsByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for Exceptions", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Exceptions response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectException" | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "exceptions" | |
| ], | |
| "summary": "Create a Project Exception", | |
| "description": "Creates Project Exception by a Project ID", | |
| "operationId": "createExceptionByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for Exceptions", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Exception object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectException" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Exception response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectException" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/exceptions/{prjex_id}": { | |
| "get": { | |
| "tags": [ | |
| "exceptions" | |
| ], | |
| "summary": "Retrieve a Project Exception", | |
| "description": "Retrieves Exception by ExceptionID", | |
| "operationId": "getExceptionByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjex_id", | |
| "description": "ID of Project Exception", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Exception response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectException" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "exceptions" | |
| ], | |
| "summary": "Update a Project Exception", | |
| "description": "Updates Exception by ExceptionID", | |
| "operationId": "updateExceptionByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjex_id", | |
| "description": "ID of Project Exception", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Exception object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectException" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Exception response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectException" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "exceptions" | |
| ], | |
| "summary": "Delete a Project Exception", | |
| "description": "Deletes Exception by ExceptionID", | |
| "operationId": "deleteExceptionByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjex_id", | |
| "description": "ID of Project Exception", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Exception response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectException" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/classifications": { | |
| "get": { | |
| "tags": [ | |
| "classifications" | |
| ], | |
| "summary": "Retrieve a Project's Classifications", | |
| "description": "Retrieves Classifications by a Project ID", | |
| "operationId": "getClassificationsByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of project for classifications", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Classifications response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectBuildingClassification" | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "classifications" | |
| ], | |
| "summary": "Create a Project Classification", | |
| "description": "Creates Classification for a Project ID", | |
| "operationId": "createClassificationByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of project for classifications", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Classification Object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectBuildingClassification" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Classifications response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectBuildingClassification" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/classifications/{prjbc_id}": { | |
| "delete": { | |
| "tags": [ | |
| "classifications" | |
| ], | |
| "summary": "Remove a Project's Classification", | |
| "description": "Removes Classification by a Project ID", | |
| "operationId": "removeClassificationByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of project for Building Classification", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjbc_id", | |
| "description": "ID of project for Building Classification", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Classifications response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectBuildingClassification" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/uoms": { | |
| "get": { | |
| "tags": [ | |
| "uoms" | |
| ], | |
| "summary": "Retrieve a Project's UOMs", | |
| "description": "Retrieves UOMs by a Project ID", | |
| "operationId": "getUOMsByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of project for uoms", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "UOMs response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectUOM" | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "uoms" | |
| ], | |
| "summary": "Create a Project UOM", | |
| "description": "Creates UOM by a Project ID", | |
| "operationId": "createUOMByProjectID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of project for uoms", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "UOM Object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectUOM" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "UOMs response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectUOM" | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/uoms/{unofm_code}": { | |
| "get": { | |
| "tags": [ | |
| "uoms" | |
| ], | |
| "summary": "Retrieve a Project UOM", | |
| "description": "Retrieves UOM by UOM Code", | |
| "operationId": "getUOMByCode", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "unofm_code", | |
| "description": "Code of Project UOM", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "UOM response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectUOM" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "uoms" | |
| ], | |
| "summary": "Update a Project UOM", | |
| "description": "Updates UOM by UOM Code", | |
| "operationId": "updateUOMByCode", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "unofm_code", | |
| "description": "Code of Project UOM", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "UOM object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectUOM" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "UOM response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectUOM" | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "uoms" | |
| ], | |
| "summary": "Delete a Project UOM", | |
| "description": "Deletes UOM by UOM Code", | |
| "operationId": "deleteUOMByCode", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "unofm_code", | |
| "description": "Code of Project UOM", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "UOM response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectUOM" | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/uoms/{unofm_code}/cost_categories": { | |
| "get": { | |
| "tags": [ | |
| "uoms", | |
| "cost-categories" | |
| ], | |
| "summary": "Retrieve a list of Project UOM Cost Categories", | |
| "description": "Retrieves Cost Categories by UOM Code", | |
| "operationId": "getUOMCostCategoriesByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "unofm_code", | |
| "description": "Code of Project UOM", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "ProjectUOMCostCategories response", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectUOMCostCategory" | |
| } | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "uoms", | |
| "cost-categories" | |
| ], | |
| "summary": "Create a Project UOM Cost Category", | |
| "description": "Creates UOM Cost Category by UOM_Code", | |
| "operationId": "createUOMCostCategoryByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "unofm_code", | |
| "description": "Code of Project UOM", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "UOM object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectUOMCostCategory" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "ProjectUOMCostCategory response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectUOMCostCategory" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/project/{prjct_id}/uoms/{unofm_code}/cost_categories/{prjcc_id}": { | |
| "get": { | |
| "tags": [ | |
| "uoms", | |
| "cost-categories" | |
| ], | |
| "summary": "Retrieve a Project UOM Cost Category", | |
| "description": "Retrieves Cost Category by ID", | |
| "operationId": "getUOMCostCategoryByCode", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "unofm_code", | |
| "description": "Code of Project UOM", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjcc_id", | |
| "description": "ID of Cost Category", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "ProjectUOMCostCategory response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectUOMCostCategory" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "uoms", | |
| "cost-categories" | |
| ], | |
| "summary": "Update a Project UOM Cost Category", | |
| "description": "Updates UOM Cost Category by ID", | |
| "operationId": "updateUOMCostCategoryByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "unofm_code", | |
| "description": "Code of Project UOM", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjcc_id", | |
| "description": "ID of Cost Category", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "UOM object for creation", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ProjectUOMCostCategory" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "ProjectUOMCostCategory response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectUOMCostCategory" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "uoms", | |
| "cost-categories" | |
| ], | |
| "summary": "Delete a Project UOM Cost Category", | |
| "description": "Deletes UOM Cost Category by ID", | |
| "operationId": "deleteUOMCostCategoryByID", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "prjct_id", | |
| "description": "ID of Project for operation", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "unofm_code", | |
| "description": "Code of Project UOM", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "prjcc_id", | |
| "description": "ID of Cost Category", | |
| "required": true, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "ProjectUOMCostCategory response", | |
| "schema": { | |
| "$ref": "#/definitions/ProjectUOMCostCategory" | |
| } | |
| }, | |
| "default": { | |
| "description": "unexpected error", | |
| "schema": { | |
| "$ref": "#/definitions/errorModel" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "LeadEnums": { | |
| "type": "object", | |
| "properties": { | |
| "fundr_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "fundr_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "progm_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "progm_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "currc_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "currc_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "tmzon_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "tmzon_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "project_group_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "asset_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "asset_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "asset_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "Project": { | |
| "type": "object", | |
| "required": [ | |
| "prjct_id", | |
| "prjst_code", | |
| "prjst_description", | |
| "version", | |
| "fundr_id", | |
| "fundr_name", | |
| "progm_id", | |
| "progm_name", | |
| "currc_code", | |
| "currc_name", | |
| "tmzon_id", | |
| "tmzon_name", | |
| "asset_id", | |
| "asset_name", | |
| "name", | |
| "job_no", | |
| "start_date", | |
| "end_date", | |
| "budget", | |
| "estimate", | |
| "description", | |
| "working_days_mo", | |
| "address1", | |
| "address2", | |
| "address3", | |
| "city", | |
| "stateprovince", | |
| "country", | |
| "longitude", | |
| "latitude", | |
| "photo", | |
| "logo", | |
| "created_by", | |
| "created_on", | |
| "updated_by", | |
| "updated_on", | |
| "user_ref" | |
| ], | |
| "properties": { | |
| "baseline": { | |
| "type": "boolean" | |
| }, | |
| "prjct_id": { | |
| "type": "integer" | |
| }, | |
| "prjst_code": { | |
| "type": "string" | |
| }, | |
| "prjst_description": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "integer" | |
| }, | |
| "fundr_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "fundr_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "fundr_id": { | |
| "type": "integer" | |
| }, | |
| "fundr_name": { | |
| "type": "string" | |
| }, | |
| "progm_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "progm_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "progm_id": { | |
| "type": "integer" | |
| }, | |
| "progm_name": { | |
| "type": "string" | |
| }, | |
| "currc_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "currc_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "currc_code": { | |
| "type": "string" | |
| }, | |
| "currc_name": { | |
| "type": "string" | |
| }, | |
| "tmzon_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "tmzon_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "tmzon_id": { | |
| "type": "integer" | |
| }, | |
| "tmzon_name": { | |
| "type": "string" | |
| }, | |
| "project_group_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "asset_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "project_group_id": { | |
| "type": "integer" | |
| }, | |
| "project_group_name": { | |
| "type": "string" | |
| }, | |
| "asset_enum": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "asset_id": { | |
| "type": "number", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "asset_id": { | |
| "type": "integer" | |
| }, | |
| "asset_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "job_no": { | |
| "type": "string" | |
| }, | |
| "start_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "end_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "budget": { | |
| "type": "integer", | |
| "format": "double" | |
| }, | |
| "estimate": { | |
| "type": "integer", | |
| "format": "double" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "working_days_mo": { | |
| "type": "integer" | |
| }, | |
| "address1": { | |
| "type": "string" | |
| }, | |
| "address2": { | |
| "type": "string" | |
| }, | |
| "address3": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "stateprovince": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "latitude": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "photo": { | |
| "type": "string" | |
| }, | |
| "logo": { | |
| "type": "string" | |
| }, | |
| "created_by": { | |
| "type": "string" | |
| }, | |
| "created_on": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "updated_by": { | |
| "type": "string" | |
| }, | |
| "updated_on": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "user_ref": { | |
| "type": "string" | |
| }, | |
| "lead_estimate_amount": { | |
| "type": "integer", | |
| "format": "double" | |
| }, | |
| "base": { | |
| "$ref": "#/definitions/ProjectBase" | |
| } | |
| } | |
| }, | |
| "ProjectBase": { | |
| "type": "object", | |
| "properties": { | |
| "appendicies": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectAppendix" | |
| } | |
| }, | |
| "classifications": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectBuildingClassification" | |
| } | |
| }, | |
| "configurations": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectConfiguration" | |
| } | |
| }, | |
| "contributors": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectContributor" | |
| } | |
| }, | |
| "cost_categories": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectCostCategory" | |
| } | |
| }, | |
| "elements": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectElement" | |
| } | |
| }, | |
| "exceptions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectException" | |
| } | |
| }, | |
| "uoms": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectUOM" | |
| } | |
| } | |
| } | |
| }, | |
| "ProjectAttachment": { | |
| "type": "object", | |
| "properties": { | |
| "prjat_id": { | |
| "type": "integer" | |
| }, | |
| "filemane": { | |
| "type": "string" | |
| }, | |
| "attachmentTagMap": { | |
| "$ref": "#/definitions/AttachmentTagMap" | |
| } | |
| } | |
| }, | |
| "ProjectElement": { | |
| "type": "object", | |
| "properties": { | |
| "prjel_id": { | |
| "type": "integer" | |
| }, | |
| "prjct_id": { | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "integer" | |
| }, | |
| "inelm_code": { | |
| "type": "string" | |
| }, | |
| "mjelm_code": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "PutProject": { | |
| "type": "object", | |
| "required": [ | |
| "prjct_id", | |
| "prjst_code", | |
| "prjst_description", | |
| "version", | |
| "fundr_id", | |
| "fundr_name", | |
| "progm_id", | |
| "progm_name", | |
| "currc_code", | |
| "currc_name", | |
| "tmzon_id", | |
| "tmzon_name", | |
| "asset_id", | |
| "asset_name", | |
| "name", | |
| "job_no", | |
| "start_date", | |
| "end_date", | |
| "budget", | |
| "estimate", | |
| "description", | |
| "working_days_mo", | |
| "address1", | |
| "address2", | |
| "address3", | |
| "city", | |
| "stateprovince", | |
| "country", | |
| "longitude", | |
| "latitude", | |
| "photo", | |
| "logo", | |
| "user_ref" | |
| ], | |
| "properties": { | |
| "is_baseline": { | |
| "type": "boolean" | |
| }, | |
| "prjct_id": { | |
| "type": "integer" | |
| }, | |
| "prjst_code": { | |
| "type": "string" | |
| }, | |
| "prjst_description": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "integer" | |
| }, | |
| "fundr_id": { | |
| "type": "integer" | |
| }, | |
| "fundr_name": { | |
| "type": "string" | |
| }, | |
| "progm_id": { | |
| "type": "integer" | |
| }, | |
| "progm_name": { | |
| "type": "string" | |
| }, | |
| "currc_code": { | |
| "type": "string" | |
| }, | |
| "currc_name": { | |
| "type": "string" | |
| }, | |
| "tmzon_id": { | |
| "type": "integer" | |
| }, | |
| "tmzon_name": { | |
| "type": "string" | |
| }, | |
| "project_group_id": { | |
| "type": "integer" | |
| }, | |
| "project_group_name": { | |
| "type": "string" | |
| }, | |
| "asset_id": { | |
| "type": "integer" | |
| }, | |
| "asset_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "job_no": { | |
| "type": "string" | |
| }, | |
| "start_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "end_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "budget": { | |
| "type": "integer", | |
| "format": "double" | |
| }, | |
| "estimate": { | |
| "type": "integer", | |
| "format": "double" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "working_days_mo": { | |
| "type": "integer" | |
| }, | |
| "address1": { | |
| "type": "string" | |
| }, | |
| "address2": { | |
| "type": "string" | |
| }, | |
| "address3": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "stateprovince": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "longitude": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "latitude": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "photo": { | |
| "type": "string" | |
| }, | |
| "logo": { | |
| "type": "string" | |
| }, | |
| "user_ref": { | |
| "type": "string" | |
| }, | |
| "lead_estimate_amount": { | |
| "type": "integer", | |
| "format": "double" | |
| } | |
| } | |
| }, | |
| "ProjectConfiguration": { | |
| "type": "object", | |
| "properties": { | |
| "prjcf_id": { | |
| "type": "integer" | |
| }, | |
| "prjct_id": { | |
| "type": "integer" | |
| }, | |
| "order": { | |
| "type": "integer" | |
| }, | |
| "value1": { | |
| "type": "string" | |
| }, | |
| "value2": { | |
| "type": "string" | |
| }, | |
| "value3": { | |
| "type": "string" | |
| }, | |
| "value4": { | |
| "type": "string" | |
| }, | |
| "value5": { | |
| "type": "string" | |
| }, | |
| "attachments": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectAttachment" | |
| } | |
| } | |
| } | |
| }, | |
| "ProjectContributor": { | |
| "type": "object", | |
| "properties": { | |
| "prjcn_id": { | |
| "type": "integer" | |
| }, | |
| "prjct_id": { | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "company": { | |
| "type": "string" | |
| }, | |
| "role": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ProjectBuildingClassification": { | |
| "type": "object", | |
| "properties": { | |
| "prjbc_prjct_id": { | |
| "type": "integer" | |
| }, | |
| "bldcl_code": { | |
| "type": "string" | |
| }, | |
| "building_classifications": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/BuildingClassification" | |
| } | |
| } | |
| } | |
| }, | |
| "ProjectCostCategory": { | |
| "type": "object", | |
| "properties": { | |
| "prjcc_id": { | |
| "type": "integer" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "order": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "ProjectException": { | |
| "type": "object", | |
| "properties": { | |
| "prjex_id": { | |
| "type": "integer" | |
| }, | |
| "prjct_id": { | |
| "type": "integer" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "ProjectAppendix": { | |
| "type": "object", | |
| "properties": { | |
| "prjap_id": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "apxtp_id": { | |
| "type": "integer" | |
| }, | |
| "apxtp_name": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "integer" | |
| }, | |
| "attachments": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectAttachment" | |
| } | |
| } | |
| } | |
| }, | |
| "ProjectUOM": { | |
| "type": "object", | |
| "properties": { | |
| "prjct_id": { | |
| "type": "integer" | |
| }, | |
| "unofm_code": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "integer" | |
| }, | |
| "quantity": { | |
| "type": "integer" | |
| }, | |
| "calc_total": { | |
| "type": "boolean" | |
| }, | |
| "project_uom_cost_categories": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProjectUOMCostCategory" | |
| } | |
| } | |
| } | |
| }, | |
| "ProjectUOMCostCategory": { | |
| "type": "object", | |
| "properties": { | |
| "prjct_id": { | |
| "type": "integer" | |
| }, | |
| "unofm_code": { | |
| "type": "string" | |
| }, | |
| "prjcc_id": { | |
| "type": "integer" | |
| }, | |
| "include_calc": { | |
| "type": "boolean" | |
| }, | |
| "project_cost_category": { | |
| "$ref": "#/definitions/ProjectCostCategory" | |
| } | |
| } | |
| }, | |
| "AttachmentTagMap": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "attgm_id": { | |
| "type": "integer" | |
| }, | |
| "attag_tag": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "BuildingClassification": { | |
| "type": "object", | |
| "properties": { | |
| "bldcl_code": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "code_parent": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "errorModel": { | |
| "type": "object", | |
| "required": [ | |
| "code", | |
| "message" | |
| ], | |
| "properties": { | |
| "code": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment