{ "swagger": "2.0", "info": { "description": "MicroService for GSA IAE Modernized Opportunity", "version": "0.1.0", "title": "GSA IAE Opportunity Modernization", "termsOfService": "https://beta.sam.gov", "contact": { }, "license": { "url": "http://unlicense.org" } }, "host": "localhost:8080", "basePath": "/", "tags": [ { "name": "opps-controller", "description": "Opps Controller" } ], "paths": { "/opps/v1/api/archive/{opportunityId}": { "post": { "tags": [ "Opportunity" ], "summary": "Archive contract opportunity", "description": "Archive contract opportunity.", "operationId": "archiveOpportunityUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "201": { "description": "Created" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/attachments": { "get": { "tags": [ "attachments" ], "summary": "Download all attachments from an opportunity", "description": "Download attachments for an opportunity.", "operationId": "downloadAttchmentsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "excludeDeleted", "in": "query", "description": "excludeDeleted ", "required": false, "type": "boolean", "allowEmptyValue": false }, { "name": "opportunityId", "in": "query", "description": "opportunityId", "required": true, "type": "string", "allowEmptyValue": false }, { "name": "resourceId", "in": "query", "description": "resourceId ", "required": false, "type": "string", "allowEmptyValue": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/cancel/{opportunityId}": { "post": { "tags": [ "Opportunity" ], "summary": "Cancel contract opportunity", "description": "Cancel contract opportunity.", "operationId": "cancelOpportunityUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "201": { "description": "Created" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/create": { "post": { "tags": [ "Opportunity" ], "summary": "Create contract opportunity", "description": "Create contract opportunity.", "operationId": "createOpportunityUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "201": { "description": "Created" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/delete/{opportunityId}": { "delete": { "tags": [ "Opportunity" ], "summary": "Delete contract opportunity", "description": "Delete contract opportunity.", "operationId": "deleteOpportunityUsingDELETE", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/history/{opportunityId}": { "get": { "tags": [ "Opportunity" ], "summary": "Get history of Opportunity", "operationId": "getOpportunityHistoryUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "name": "postedFrom", "in": "query", "description": "postedFrom", "required": false, "type": "string", "format": "date-time", "allowEmptyValue": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/isSolicitationNumberUnique/{parent}/{solicitationNumber}/{type}": { "get": { "tags": [ "Opportunity" ], "summary": "Check if solicitation number is unique. A solicitation number is unique if it is not used by another opportunity of equivalent type. For justification type, j&a and fair opportunity/limited sources justification are considered equivalent.", "operationId": "getOpportunityHistoryUsingGET_1", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "parent", "in": "path", "description": "parent", "required": false, "type": "string" }, { "name": "solicitationNumber", "in": "path", "description": "solicitationNumber", "required": true, "type": "string" }, { "name": "type", "in": "path", "description": "type", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/opportunities/{opportunityId}/relatedopportunities/{type}": { "get": { "tags": [ "Opportunity" ], "summary": "Get related contract opportunities", "operationId": "getRelatedOpportunitiesGET", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "name": "page", "in": "query", "description": "page", "required": false, "type": "integer", "default": 0, "format": "int32", "allowEmptyValue": false }, { "name": "size", "in": "query", "description": "size", "required": false, "type": "integer", "default": 10, "format": "int32", "allowEmptyValue": false }, { "name": "sortBy", "in": "query", "description": "sortBy", "required": false, "type": "string", "default": "-modifiedOn", "allowEmptyValue": false }, { "name": "type", "in": "path", "description": "type", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/organization/{orgId}/ivl": { "put": { "tags": [ "IVL" ], "summary": "Save IVL Settings", "description": "Save IVL Settings by Organization.", "operationId": "saveIVLOrganizationSettingsByIOrgIdUsingPUT", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "orgId", "in": "path", "description": "orgId", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "201": { "description": "Created" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "412": { "description": "Precondition Failed" }, "428": { "description": "Precondition Required" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/publish/{opportunityId}": { "post": { "tags": [ "Opportunity" ], "summary": "Publish contract opportunity", "description": "Publish contract opportunity.", "operationId": "publishOpportunityUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "201": { "description": "Created" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/resources/files/{resourceId}/download": { "get": { "tags": [ "attachments" ], "summary": "get attachment", "description": "get attachment.", "operationId": "getAttachmentUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "resourceId", "in": "path", "description": "resourceId", "required": true, "type": "string" }, { "name": "status", "in": "query", "description": "status", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "token", "in": "query", "description": "token", "required": false, "type": "string", "allowEmptyValue": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/revise/{opportunityId}": { "post": { "tags": [ "Opportunity" ], "summary": "Revise contract opportunity", "description": "Revise contract opportunity.", "operationId": "reviseOpportunityUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "201": { "description": "Created" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/search": { "get": { "tags": [ "Opportunity" ], "summary": "Get Opportunities", "description": "Get all opportunities.", "operationId": "getOpportunitiesUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "archivedFrom", "in": "query", "description": "archivedFrom", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "archivedTo", "in": "query", "description": "archivedTo", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "awardNumber", "in": "query", "description": "awardNumber", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "cancelled", "in": "query", "description": "cancelled", "required": false, "type": "boolean", "default": false, "allowEmptyValue": false, "x-example": false }, { "name": "doNumber", "in": "query", "description": "doNumber", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "facets", "in": "query", "description": "facets", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "allowEmptyValue": false }, { "name": "includeCount", "in": "query", "description": "includeCount", "required": false, "type": "boolean", "default": true, "allowEmptyValue": false }, { "name": "keyword", "in": "query", "description": "keyword", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "latest", "in": "query", "description": "latest", "required": false, "type": "boolean", "default": true, "allowEmptyValue": false }, { "name": "links", "in": "query", "description": "links", "required": false, "type": "boolean", "default": true, "allowEmptyValue": false }, { "name": "noticeType", "in": "query", "description": "noticeType", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "allowEmptyValue": false }, { "name": "opportunityIds", "in": "query", "description": "opportunityIds", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "allowEmptyValue": false }, { "name": "organizationId", "in": "query", "description": "organizationId", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "allowEmptyValue": false }, { "name": "page", "in": "query", "description": "page", "required": false, "type": "integer", "default": 0, "format": "int32", "allowEmptyValue": false }, { "name": "parentNotice", "in": "query", "description": "parentNotice", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "allowEmptyValue": false }, { "name": "postedFrom", "in": "query", "description": "postedFrom", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "postedTo", "in": "query", "description": "postedTo", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "relatedNotice", "in": "query", "description": "relatedNotice", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "allowEmptyValue": false }, { "name": "responseFrom", "in": "query", "description": "responseFrom", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "responseTo", "in": "query", "description": "responseTo", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "size", "in": "query", "description": "size", "required": false, "type": "integer", "default": 10, "format": "int32", "allowEmptyValue": false }, { "name": "solNumber", "in": "query", "description": "solNumber", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "sortBy", "in": "query", "description": "sortBy", "required": false, "type": "string", "default": "-modifiedOn", "allowEmptyValue": false }, { "name": "status", "in": "query", "description": "status", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "allowEmptyValue": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "security": [ { "Token-based Access": [] } ], "deprecated": false } }, "/opps/v1/api/unarchive/{opportunityId}": { "post": { "tags": [ "Opportunity" ], "summary": "UnArchive contract opportunity", "description": "UnArchive contract opportunity.", "operationId": "unArchiveOpportunityUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "201": { "description": "Created" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/uncancel/{opportunityId}": { "post": { "tags": [ "Opportunity" ], "summary": "UnCancel contract opportunity", "description": "UnCancel contract opportunity.", "operationId": "unCancelOpportunityUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "201": { "description": "Created" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/update/{opportunityId}": { "patch": { "tags": [ "Opportunity" ], "summary": "Update Opportunity", "description": "Update contract opportunity.", "operationId": "updateOpportunityUsingPATCH", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "412": { "description": "Precondition Failed" }, "428": { "description": "Precondition Required" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/{opportunityId}": { "get": { "tags": [ "Opportunity" ], "summary": "Get contract opportunity", "description": "Get contract opportunity.", "operationId": "getOpportunityUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "latest", "in": "query", "description": "latest", "required": false, "type": "boolean", "default": false, "allowEmptyValue": false, "x-example": false }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "security": [ { "Token-based Access": [] } ], "deprecated": false } }, "/opps/v1/api/{opportunityId}/attachments": { "post": { "tags": [ "attachments" ], "summary": "Add attachment to an opportunity", "description": "Add attachment to an opportunity.", "operationId": "createAttachmentUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "201": { "description": "Created" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/{opportunityId}/attachments/{resourceId}": { "delete": { "tags": [ "attachments" ], "summary": "Delete attachment for an opportunity", "description": "Delete attachment for an opportunity.", "operationId": "deleteAttachmentUsingDELETE", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "deleteAll", "in": "query", "description": "deleteAll", "required": true, "type": "string", "default": "false", "allowEmptyValue": false }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "name": "resourceId", "in": "path", "description": "resourceId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false }, "patch": { "tags": [ "attachments" ], "summary": "Update attachment to an opportunity", "description": "Update attachment for an opportunity.", "operationId": "updateAttachmentUsingPATCH", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" }, { "in": "body", "name": "requestJson", "description": "requestJson", "required": false, "schema": { "type": "string" } }, { "name": "resourceId", "in": "path", "description": "resourceId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v1/api/{opportunityId}/ivl": { "get": { "tags": [ "IVL" ], "summary": "Get IVL", "description": "Get IVL for contract opportunity.", "operationId": "getIVLUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "security": [ { "Token-based Access": [] } ], "deprecated": false } }, "/opps/v1/api/{opportunityId}/ivl/{duns}": { "get": { "tags": [ "IVL" ], "summary": "Get IVL by DUNS", "description": "Get IVL by DUNS for contract opportunity.", "operationId": "getIVLByDUNS", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "duns", "in": "path", "description": "duns", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "security": [ { "Token-based Access": [] } ], "deprecated": false } }, "/opps/v1/api/{opportunityId}/resources/download/zip": { "get": { "tags": [ "attachments" ], "summary": "Download Opportunity's attachments as zip", "description": "Download Opportunity's attachments as zip.", "operationId": "downloadAttachmentsAsZipUsingGET", "produces": [ "application/zip" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } }, "/opps/v2/opportunities/{opportunityId}/ivl/{entityid}": { "delete": { "tags": [ "IVL" ], "summary": "Delete Vendor for Opportunity", "description": "Delete Vendor for Opportunity.", "operationId": "deleteVendorUsingDELETE", "produces": [ "application/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization", "required": true, "type": "string" }, { "name": "api_key", "in": "query", "description": "api_key", "required": true, "type": "string" }, { "name": "entityid", "in": "path", "description": "entityid", "required": true, "type": "string" }, { "name": "opportunityId", "in": "path", "description": "opportunityId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "schema": { "type": "string" } }, "501": { "description": "Not Implemented", "schema": { "type": "string" } } }, "deprecated": false } } } }