{ "documentName": "v1", "baselineVersion": 15, "approval": { "classification": "testing-tier-public-surface", "approvedOn": "2026-11-10" }, "contract": { "paths": { "/v1/capabilities": { "get": { "operationId": "GetEffectiveCapabilities", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EffectiveCapabilitiesResponse" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "500": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/item-mapping-requests": { "post": { "operationId": "SubmitSingleItemMapping", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemMappingRequestV1" }, "example": { "company_item_id": "CUSTOMER-1001", "description": "Synthetic copper elbow", "mfr_name": "Synthetic Manufacturer", "mfr_part": "SYN-90", "size": "2 in", "weight": 1.250000, "list_price": 12.3400 } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemMappingResponseV1" }, "example": { "contract_version": "v1", "operation_reference": "mapop_0123456789abcdef0123456789abcdef", "correlation_id": "example-correlation", "company_item_id": "CUSTOMER-1001", "result_revision": 1, "status": "review_required", "reason_codes": [ "candidate_review_required" ], "candidates": [ { "candidate_token": "candidate_0123456789abcdef0123456789abcdef", "rank": 1, "manufacturer": "Synthetic Manufacturer", "description": "Synthetic candidate", "product": "Synthetic Product", "material": "Synthetic Material", "size": "2 in", "item_status": "active", "match_strength": "strong", "evidence": [ { "type": "description", "outcome": "consistent" } ], "warnings": [] } ], "next_action": "review_candidates", "available_actions": [ { "action": "get_current_result", "title": "Retrieve current mapping result", "description": "Retrieves the latest disclosed result and currently available follow-up actions. It does not change the mapping operation.", "operation_id": "GetSingleItemMappingCurrentResult", "method": "GET", "href": "/v1/item-mapping-requests/mapop_0123456789abcdef0123456789abcdef", "request_body_required": false, "idempotency_key_required": false, "confirmation_required": false }, { "action": "expand_candidates", "title": "Expand mapping candidates", "description": "Requests up to ten additional candidates and advances the result revision. It does not approve or activate a mapping.", "operation_id": "ExpandSingleItemMappingCandidates", "method": "POST", "href": "/v1/item-mapping-requests/mapop_0123456789abcdef0123456789abcdef/candidate-expansions", "request_body_required": true, "idempotency_key_required": true, "confirmation_required": true } ], "completed_at": "2026-10-12T12:00:00Z", "reused": false } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "413": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/item-mapping-requests/{operation_reference}": { "get": { "operationId": "GetSingleItemMappingCurrentResult", "parameters": [ { "name": "operation_reference", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemMappingCurrentResultResponseV1" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/item-mapping-requests/{operation_reference}/candidate-expansions": { "post": { "operationId": "ExpandSingleItemMappingCandidates", "parameters": [ { "name": "operation_reference", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemCandidateExpansionRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemMappingCurrentResultResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/item-mapping-requests/{operation_reference}/review-proposals": { "post": { "operationId": "AcceptSingleItemMappingForReview", "parameters": [ { "name": "operation_reference", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemAcceptForReviewRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemReviewProposalResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/item-mapping-requests/{operation_reference}/ignore-decisions": { "post": { "operationId": "IgnoreSingleItemMapping", "parameters": [ { "name": "operation_reference", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemIgnoreDecisionRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemIgnoreDecisionResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/item-mapping-requests/{operation_reference}/production-releases": { "post": { "operationId": "ReleaseSingleItemMappingToProduction", "parameters": [ { "name": "operation_reference", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemProductionReleaseRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleItemProductionReleaseResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/mapping": { "get": { "operationId": "GetCompanyItemCurrentMapping", "parameters": [ { "name": "company_item_id", "in": "query", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyItemCurrentMappingResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } }, "put": { "operationId": "SetCompanyItemMapping", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDirectCompanyItemMappingRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDirectCompanyItemMappingResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "422": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/mapping/associations": { "get": { "operationId": "ListCompanyItemCurrentMappingAssociations", "parameters": [ { "name": "company_item_id", "in": "query", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "mapping_revision", "in": "query", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 100, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "continuation", "in": "query", "schema": { "maxLength": 64, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyItemCurrentMappingAssociationsResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/mapping/history": { "get": { "operationId": "ListCompanyItemMappingHistory", "parameters": [ { "name": "company_item_id", "in": "query", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 25, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "continuation", "in": "query", "schema": { "maxLength": 64, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyItemMappingHistoryResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/mapping/history/{mapping_revision}/associations": { "get": { "operationId": "ListCompanyItemHistoricalMappingAssociations", "parameters": [ { "name": "company_item_id", "in": "query", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "mapping_revision", "in": "path", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 100, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "continuation", "in": "query", "schema": { "maxLength": 64, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyItemHistoricalAssociationsResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/mapping/restorations": { "post": { "operationId": "RestorePreviousCompanyItemMapping", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreDirectCompanyItemMappingRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreEmptyCompanyItemMappingResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "422": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/hph/catalog/items/details": { "post": { "operationId": "GetHphItemDetailsByCodeBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HphItemDetailsByCodeBatchRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HphItemDetailsByCodeBatchResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/hph/catalog/items/catalog-usage": { "post": { "operationId": "ListCompanyItemsByHphItemCode", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HphItemCatalogUsageRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HphItemCatalogUsageResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/details": { "post": { "operationId": "GetCompanyItemDetailsBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyItemDetailsBatchRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyItemDetailsBatchResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/price-labor": { "post": { "operationId": "GetCompanyItemPriceLaborBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyItemPriceLaborBatchRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyItemPriceLaborBatchResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/labor-hours": { "post": { "operationId": "GetCompanyItemLaborHours", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyItemLaborHoursBatchRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyItemLaborHoursBatchResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items": { "post": { "operationId": "CreateCompanyCatalogItem", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompanyCatalogItemRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompanyCatalogItemResponseV1" } } } }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompanyCatalogItemResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/hph/catalog/items/alternatives": { "post": { "operationId": "GetHphItemAlternatives", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HphItemAlternativesRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HphItemAlternativesResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/alternatives": { "post": { "operationId": "GetHphItemAlternativesByCompanyItem", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HphItemAlternativesByCompanyItemRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HphItemAlternativesResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/alternative-selections": { "post": { "operationId": "SelectHphItemAlternative", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectHphItemAlternativeRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectHphItemAlternativeResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "422": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/autodesk-fabrication/item-mapping-requests": { "post": { "operationId": "SubmitAutodeskFabricationItemMapping", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutodeskFabricationItemMappingRequestV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutodeskFabricationItemMappingResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "413": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/me": { "get": { "operationId": "GetCurrentActor", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentActorResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/company/capabilities": { "get": { "operationId": "GetCompanyCapabilities", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCapabilitiesResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/company/usage": { "get": { "operationId": "GetCompanyUsage", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "through", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyUsageResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/catalog/items/search": { "get": { "operationId": "SearchMaterialCatalogItems", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialCatalogSearchResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/vendors": { "get": { "operationId": "ListMaterialVendors", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialVendorCollectionResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } }, "/v1/vendors/{vendor_skey}/accounts": { "get": { "operationId": "ListMaterialVendorAccounts", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorAccountCollectionResponseV1" } } } }, "400": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "401": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "403": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "404": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "409": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "429": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } }, "503": { "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/ExternalProblem" } } } } } } } }, "schemas": { "AutodeskFabricationCandidateV1": { "required": [ "candidate_token", "rank", "hph_item_code", "manufacturer", "description", "product", "material", "size", "item_status", "review_classification", "reasons", "warnings" ], "type": "object", "properties": { "candidate_token": { "type": "string" }, "rank": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hph_item_code": { "type": "string" }, "manufacturer": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "product": { "type": [ "null", "string" ] }, "material": { "type": [ "null", "string" ] }, "size": { "type": [ "null", "string" ] }, "item_status": { "type": "string" }, "review_classification": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "AutodeskFabricationCompanyItemV1": { "required": [ "resolution", "company_item_id", "mapping_revision" ], "type": "object", "properties": { "resolution": { "type": "string" }, "company_item_id": { "type": [ "null", "string" ] }, "mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" } }, "additionalProperties": false }, "AutodeskFabricationExistingMappingV1": { "required": [ "hph_item_code", "mapping_revision" ], "type": "object", "properties": { "hph_item_code": { "type": "string" }, "mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, "additionalProperties": false }, "AutodeskFabricationItemMappingRequestV1": { "required": [ "fabrication_item" ], "type": "object", "properties": { "fabrication_item": { "$ref": "#/components/schemas/AutodeskFabricationItemV1" } }, "additionalProperties": false }, "AutodeskFabricationItemMappingResponseV1": { "required": [ "contract_version", "operation_reference", "correlation_id", "fabrication_item_id", "company_item", "request_revision", "result_revision", "mapping_revision", "status", "existing_mapping", "claimed_hph_item_code_status", "candidates", "available_actions", "next_action", "completed_at", "reused" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "operation_reference": { "type": "string" }, "correlation_id": { "type": "string" }, "fabrication_item_id": { "type": "string" }, "company_item": { "$ref": "#/components/schemas/AutodeskFabricationCompanyItemV1" }, "request_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "result_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "status": { "type": "string" }, "existing_mapping": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AutodeskFabricationExistingMappingV1" } ] }, "claimed_hph_item_code_status": { "type": [ "null", "string" ] }, "candidates": { "type": "array", "items": { "$ref": "#/components/schemas/AutodeskFabricationCandidateV1" } }, "available_actions": { "type": "array", "items": { "type": "string" } }, "next_action": { "type": "string" }, "completed_at": { "type": "string", "format": "date-time" }, "reused": { "type": "boolean" } }, "additionalProperties": false }, "AutodeskFabricationItemV1": { "required": [ "id", "description" ], "type": "object", "properties": { "id": { "maxLength": 255, "minLength": 1, "type": "string" }, "description": { "maxLength": 4096, "minLength": 1, "type": "string" }, "group": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "manufacturer": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "product": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "size": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "material": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "specification": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "install_type": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "source_description": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "range": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "finish": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "upc": { "maxLength": 255, "minLength": 0, "type": [ "null", "string" ] }, "oem_code": { "maxLength": 255, "minLength": 0, "type": [ "null", "string" ] }, "claimed_hph_item_code": { "maxLength": 128, "minLength": 0, "type": [ "null", "string" ] }, "path": { "maxLength": 2048, "minLength": 0, "type": [ "null", "string" ] } }, "additionalProperties": false }, "CompanyCapabilitiesResponseV1": { "required": [ "contract_version", "capabilities", "evaluated_at" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "capabilities": { "maxItems": 32, "type": "array", "items": { "type": "string" } }, "evaluated_at": { "type": "string", "format": "date-time" } } }, "CompanyCatalogItemCreatedV1": { "required": [ "item_skey", "company_item_id", "alternate_company_item_id", "company_description", "lifecycle", "item_history_revision", "observed_at" ], "type": "object", "properties": { "item_skey": { "type": "string", "format": "uuid" }, "company_item_id": { "type": [ "null", "string" ] }, "alternate_company_item_id": { "type": [ "null", "string" ] }, "company_description": { "type": [ "null", "string" ] }, "lifecycle": { "type": "string" }, "item_history_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "observed_at": { "type": "string", "format": "date-time" } } }, "CompanyDailyUsageV1": { "required": [ "date", "request_count", "returned_item_count", "hph_item_codes_delivered", "unique_hph_item_codes_delivered" ], "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "request_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "returned_item_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "hph_item_codes_delivered": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "unique_hph_item_codes_delivered": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "CompanyItemBatchEntryV1": { "required": [ "request_key", "selector" ], "type": "object", "properties": { "request_key": { "maxLength": 64, "minLength": 0, "type": [ "null", "string" ] }, "selector": { "$ref": "#/components/schemas/CompanyItemSelectorV1" } }, "additionalProperties": false }, "CompanyItemCatalogUsageEntryV1": { "required": [ "item_skey", "company_item_id", "company_item_alt_id", "description", "lifecycle", "mapping_revision", "effective_at" ], "type": "object", "properties": { "item_skey": { "type": "string", "format": "uuid" }, "company_item_id": { "type": [ "null", "string" ] }, "company_item_alt_id": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "lifecycle": { "type": "string" }, "mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "effective_at": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CompanyItemCurrentMappingAssociationsResponseV1": { "required": [ "contract_version", "item_skey", "company_item_id", "mapping_revision", "association_count", "associations", "links" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "item_skey": { "type": "string", "format": "uuid" }, "company_item_id": { "maxLength": 255, "minLength": 0, "type": "string" }, "mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "association_count": { "maximum": 1, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "associations": { "maxItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CompanyItemMappingAssociationV1" } }, "links": { "$ref": "#/components/schemas/CompanyItemMappingCollectionLinksV1" } } }, "CompanyItemCurrentMappingLinksV1": { "required": [ "self", "history" ], "type": "object", "properties": { "self": { "maxLength": 2048, "minLength": 0, "type": "string" }, "associations": { "maxLength": 2048, "minLength": 0, "type": [ "null", "string" ] }, "history": { "maxLength": 2048, "minLength": 0, "type": "string" } } }, "CompanyItemCurrentMappingResponseV1": { "required": [ "contract_version", "item_skey", "company_item_id", "mapping", "links" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "item_skey": { "type": "string", "format": "uuid" }, "company_item_id": { "maxLength": 255, "minLength": 0, "type": "string" }, "mapping": { "$ref": "#/components/schemas/CompanyItemMappingStateV1" }, "links": { "$ref": "#/components/schemas/CompanyItemCurrentMappingLinksV1" } } }, "CompanyItemDetailsBatchRequestV1": { "required": [ "items" ], "type": "object", "properties": { "items": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CompanyItemBatchEntryV1" } } }, "additionalProperties": false }, "CompanyItemDetailsBatchResponseV1": { "required": [ "contract_version", "results" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "results": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/CompanyItemDetailsBatchResultV1" } } }, "additionalProperties": false }, "CompanyItemDetailsBatchResultV1": { "required": [ "outcome" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/CompanyItemDetailsBatchResultV1AvailableCompanyItemDetailsBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemDetailsBatchResultV1NotFoundCompanyItemDetailsBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemDetailsBatchResultV1MappingRequiredCompanyItemDetailsBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemDetailsBatchResultV1AmbiguousCompanyItemDetailsBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemDetailsBatchResultV1UnavailableCompanyItemDetailsBatchResultV1" } ], "discriminator": { "propertyName": "outcome", "mapping": { "available": "#/components/schemas/CompanyItemDetailsBatchResultV1AvailableCompanyItemDetailsBatchResultV1", "not_found_or_concealed": "#/components/schemas/CompanyItemDetailsBatchResultV1NotFoundCompanyItemDetailsBatchResultV1", "mapping_required": "#/components/schemas/CompanyItemDetailsBatchResultV1MappingRequiredCompanyItemDetailsBatchResultV1", "ambiguous": "#/components/schemas/CompanyItemDetailsBatchResultV1AmbiguousCompanyItemDetailsBatchResultV1", "temporarily_unavailable": "#/components/schemas/CompanyItemDetailsBatchResultV1UnavailableCompanyItemDetailsBatchResultV1" } } }, "CompanyItemDetailsBatchResultV1AmbiguousCompanyItemDetailsBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "ambiguous" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemDetailsBatchResultV1AvailableCompanyItemDetailsBatchResultV1": { "required": [ "details", "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "available" ], "type": "string" }, "details": { "$ref": "#/components/schemas/CompanyItemDetailsResponseV1" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemDetailsBatchResultV1MappingRequiredCompanyItemDetailsBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "mapping_required" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemDetailsBatchResultV1NotFoundCompanyItemDetailsBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "not_found_or_concealed" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemDetailsBatchResultV1UnavailableCompanyItemDetailsBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "temporarily_unavailable" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemDetailsResponseV1": { "required": [ "item_skey", "item_ids", "size", "descriptions", "manufacturer", "availability_status", "categorization", "manufacturer_list_price", "labor_hours", "weight", "notices" ], "type": "object", "properties": { "item_skey": { "type": "string", "format": "uuid" }, "item_ids": { "$ref": "#/components/schemas/ItemIdentifiersV1" }, "size": { "type": [ "null", "string" ] }, "descriptions": { "$ref": "#/components/schemas/ItemDescriptionsV1" }, "manufacturer": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ManufacturerV1" } ] }, "availability_status": { "type": "string" }, "categorization": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/HphCategorizationV1" } ] }, "manufacturer_list_price": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ManufacturerListPriceV1" } ] }, "labor_hours": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LaborHourV1" } }, "weight": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MeasurementV1" } ] }, "notices": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseNoticeV1" } } }, "additionalProperties": false }, "CompanyItemHistoricalAssociationsResponseV1": { "required": [ "contract_version", "item_skey", "company_item_id", "mapping_revision", "association_count", "associations", "links" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "item_skey": { "type": "string", "format": "uuid" }, "company_item_id": { "maxLength": 255, "minLength": 0, "type": "string" }, "mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "association_count": { "maximum": 1, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "associations": { "maxItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CompanyItemHistoricalAssociationV1" } }, "links": { "$ref": "#/components/schemas/CompanyItemMappingCollectionLinksV1" } } }, "CompanyItemHistoricalAssociationV1": { "required": [ "hph_item_code" ], "type": "object", "properties": { "hph_item_code": { "maxLength": 128, "minLength": 0, "type": "string" } } }, "CompanyItemLaborHoursBatchRequestV1": { "required": [ "items", "labor_hours_filter" ], "type": "object", "properties": { "items": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CompanyItemBatchEntryV1" } }, "labor_hours_filter": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LaborHoursFilterV1" } ] } }, "additionalProperties": false }, "CompanyItemLaborHoursBatchResponseV1": { "required": [ "contract_version", "results" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "results": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/CompanyItemLaborHoursBatchResultV1" } } }, "additionalProperties": false }, "CompanyItemLaborHoursBatchResultV1": { "required": [ "outcome" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/CompanyItemLaborHoursBatchResultV1AvailableCompanyItemLaborHoursBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemLaborHoursBatchResultV1NotFoundCompanyItemLaborHoursBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemLaborHoursBatchResultV1MappingRequiredCompanyItemLaborHoursBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemLaborHoursBatchResultV1AmbiguousCompanyItemLaborHoursBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemLaborHoursBatchResultV1UnavailableCompanyItemLaborHoursBatchResultV1" } ], "discriminator": { "propertyName": "outcome", "mapping": { "available": "#/components/schemas/CompanyItemLaborHoursBatchResultV1AvailableCompanyItemLaborHoursBatchResultV1", "not_found_or_concealed": "#/components/schemas/CompanyItemLaborHoursBatchResultV1NotFoundCompanyItemLaborHoursBatchResultV1", "mapping_required": "#/components/schemas/CompanyItemLaborHoursBatchResultV1MappingRequiredCompanyItemLaborHoursBatchResultV1", "ambiguous": "#/components/schemas/CompanyItemLaborHoursBatchResultV1AmbiguousCompanyItemLaborHoursBatchResultV1", "temporarily_unavailable": "#/components/schemas/CompanyItemLaborHoursBatchResultV1UnavailableCompanyItemLaborHoursBatchResultV1" } } }, "CompanyItemLaborHoursBatchResultV1AmbiguousCompanyItemLaborHoursBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "ambiguous" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemLaborHoursBatchResultV1AvailableCompanyItemLaborHoursBatchResultV1": { "required": [ "item", "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "available" ], "type": "string" }, "item": { "$ref": "#/components/schemas/CompanyItemLaborHoursV1" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemLaborHoursBatchResultV1MappingRequiredCompanyItemLaborHoursBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "mapping_required" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemLaborHoursBatchResultV1NotFoundCompanyItemLaborHoursBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "not_found_or_concealed" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemLaborHoursBatchResultV1UnavailableCompanyItemLaborHoursBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "temporarily_unavailable" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemLaborHoursV1": { "required": [ "item_skey", "hph_item_code", "labor_hours", "notices" ], "type": "object", "properties": { "item_skey": { "type": "string", "format": "uuid" }, "hph_item_code": { "maxLength": 10, "minLength": 0, "pattern": "^(?:[0-9]{3}[A-Z]{2}|010C |210C |275C1)[0-9]{4}[A-Z]?$", "type": [ "null", "string" ] }, "labor_hours": { "maxItems": 256, "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LaborHourV1" } }, "notices": { "maxItems": 32, "type": "array", "items": { "$ref": "#/components/schemas/ResponseNoticeV1" } } }, "additionalProperties": false }, "CompanyItemMappingAssociationV1": { "required": [ "hph_item_code", "item_status", "manufacturer_name", "description", "product", "material", "size" ], "type": "object", "properties": { "hph_item_code": { "maxLength": 128, "minLength": 0, "type": "string" }, "item_status": { "enum": [ "active", "inactive" ], "type": "string" }, "manufacturer_name": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "description": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "product": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "material": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "size": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] } } }, "CompanyItemMappingCollectionLinksV1": { "required": [ "current", "history", "next" ], "type": "object", "properties": { "current": { "maxLength": 2048, "minLength": 0, "type": "string" }, "history": { "maxLength": 2048, "minLength": 0, "type": "string" }, "next": { "maxLength": 2048, "minLength": 0, "type": [ "null", "string" ] } } }, "CompanyItemMappingHistoryEntryLinksV1": { "type": "object", "properties": { "associations": { "maxLength": 2048, "minLength": 0, "type": [ "null", "string" ] } } }, "CompanyItemMappingHistoryEntryV1": { "required": [ "mapping_revision", "status", "association_count", "effective_at", "superseded_at", "links" ], "type": "object", "properties": { "mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "status": { "enum": [ "active", "unmapped", "superseded" ], "type": "string" }, "association_count": { "maximum": 1, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "effective_at": { "type": "string", "format": "date-time" }, "superseded_at": { "type": [ "null", "string" ], "format": "date-time" }, "links": { "$ref": "#/components/schemas/CompanyItemMappingHistoryEntryLinksV1" } } }, "CompanyItemMappingHistoryLinksV1": { "required": [ "current", "next" ], "type": "object", "properties": { "current": { "maxLength": 2048, "minLength": 0, "type": "string" }, "next": { "maxLength": 2048, "minLength": 0, "type": [ "null", "string" ] } } }, "CompanyItemMappingHistoryResponseV1": { "required": [ "contract_version", "item_skey", "company_item_id", "current_mapping_revision", "history_availability", "entries", "links" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "item_skey": { "type": "string", "format": "uuid" }, "company_item_id": { "maxLength": 255, "minLength": 0, "type": "string" }, "current_mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "history_availability": { "enum": [ "complete", "pre_cutover_unavailable" ], "type": "string" }, "entries": { "maxItems": 25, "type": "array", "items": { "$ref": "#/components/schemas/CompanyItemMappingHistoryEntryV1" } }, "links": { "$ref": "#/components/schemas/CompanyItemMappingHistoryLinksV1" } } }, "CompanyItemMappingStateV1": { "required": [ "status", "mapping_revision", "association_count", "effective_at" ], "type": "object", "properties": { "status": { "enum": [ "active", "unmapped" ], "type": "string" }, "mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "association_count": { "maximum": 1, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "effective_at": { "type": [ "null", "string" ], "format": "date-time" } } }, "CompanyItemPriceLaborBatchRequestV1": { "required": [ "items" ], "type": "object", "properties": { "items": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CompanyItemBatchEntryV1" } } }, "additionalProperties": false }, "CompanyItemPriceLaborBatchResponseV1": { "required": [ "contract_version", "results" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "results": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/CompanyItemPriceLaborBatchResultV1" } } }, "additionalProperties": false }, "CompanyItemPriceLaborBatchResultV1": { "required": [ "outcome" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/CompanyItemPriceLaborBatchResultV1AvailableCompanyItemPriceLaborBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemPriceLaborBatchResultV1NotFoundCompanyItemPriceLaborBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemPriceLaborBatchResultV1MappingRequiredCompanyItemPriceLaborBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemPriceLaborBatchResultV1AmbiguousCompanyItemPriceLaborBatchResultV1" }, { "$ref": "#/components/schemas/CompanyItemPriceLaborBatchResultV1UnavailableCompanyItemPriceLaborBatchResultV1" } ], "discriminator": { "propertyName": "outcome", "mapping": { "available": "#/components/schemas/CompanyItemPriceLaborBatchResultV1AvailableCompanyItemPriceLaborBatchResultV1", "not_found_or_concealed": "#/components/schemas/CompanyItemPriceLaborBatchResultV1NotFoundCompanyItemPriceLaborBatchResultV1", "mapping_required": "#/components/schemas/CompanyItemPriceLaborBatchResultV1MappingRequiredCompanyItemPriceLaborBatchResultV1", "ambiguous": "#/components/schemas/CompanyItemPriceLaborBatchResultV1AmbiguousCompanyItemPriceLaborBatchResultV1", "temporarily_unavailable": "#/components/schemas/CompanyItemPriceLaborBatchResultV1UnavailableCompanyItemPriceLaborBatchResultV1" } } }, "CompanyItemPriceLaborBatchResultV1AmbiguousCompanyItemPriceLaborBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "ambiguous" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemPriceLaborBatchResultV1AvailableCompanyItemPriceLaborBatchResultV1": { "required": [ "item", "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "available" ], "type": "string" }, "item": { "$ref": "#/components/schemas/CompanyItemPriceLaborV1" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemPriceLaborBatchResultV1MappingRequiredCompanyItemPriceLaborBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "mapping_required" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemPriceLaborBatchResultV1NotFoundCompanyItemPriceLaborBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "not_found_or_concealed" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemPriceLaborBatchResultV1UnavailableCompanyItemPriceLaborBatchResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "temporarily_unavailable" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "CompanyItemPriceLaborV1": { "required": [ "item_skey", "hph_item_code", "manufacturer_list_price", "labor_hours", "notices" ], "type": "object", "properties": { "item_skey": { "type": "string", "format": "uuid" }, "hph_item_code": { "maxLength": 10, "minLength": 0, "pattern": "^(?:[0-9]{3}[A-Z]{2}|010C |210C |275C1)[0-9]{4}[A-Z]?$", "type": [ "null", "string" ] }, "manufacturer_list_price": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ManufacturerListPriceV1" } ] }, "labor_hours": { "maxItems": 1, "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LaborHourV1" } }, "notices": { "maxItems": 32, "type": "array", "items": { "$ref": "#/components/schemas/ResponseNoticeV1" } } }, "additionalProperties": false }, "CompanyItemSelectorV1": { "required": [ "item_skey", "company_item_identifier", "hph_item_code" ], "type": "object", "properties": { "item_skey": { "type": [ "null", "string" ], "format": "uuid" }, "company_item_identifier": { "maxLength": 255, "minLength": 0, "type": [ "null", "string" ] }, "hph_item_code": { "maxLength": 10, "minLength": 0, "pattern": "^(?:[0-9]{3}[A-Z]{2}|010C |210C |275C1)[0-9]{4}[A-Z]?$", "type": [ "null", "string" ] } }, "additionalProperties": false }, "CompanyProtectedContentUsageV1": { "required": [ "hph_item_codes_delivered", "unique_hph_item_codes_delivered", "hph_item_codes_withheld", "quota_denied_request_count" ], "type": "object", "properties": { "hph_item_codes_delivered": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "unique_hph_item_codes_delivered": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "hph_item_codes_withheld": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "quota_denied_request_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "CompanyQuotaStatusV1": { "required": [ "quota", "maximum", "consumed", "reserved", "remaining", "resets_at", "measured_at" ], "type": "object", "properties": { "quota": { "maxLength": 64, "type": "string" }, "maximum": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "consumed": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "reserved": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "remaining": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "resets_at": { "type": [ "null", "string" ], "format": "date-time" }, "measured_at": { "type": [ "null", "string" ], "format": "date-time" } } }, "CompanyUsagePeriodV1": { "required": [ "from", "through", "timezone" ], "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "through": { "type": "string", "format": "date" }, "timezone": { "type": "string" } } }, "CompanyUsageResponseV1": { "required": [ "contract_version", "evaluated_at", "data_through", "period", "api_usage", "quotas" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "evaluated_at": { "type": "string", "format": "date-time" }, "data_through": { "type": "string", "format": "date-time" }, "period": { "$ref": "#/components/schemas/CompanyUsagePeriodV1" }, "api_usage": { "$ref": "#/components/schemas/CompanyUsageV1" }, "quotas": { "maxItems": 32, "type": "array", "items": { "$ref": "#/components/schemas/CompanyQuotaStatusV1" } } } }, "CompanyUsageSummaryV1": { "required": [ "request_count", "successful_request_count", "denied_request_count", "failed_request_count", "submitted_item_count", "returned_item_count" ], "type": "object", "properties": { "request_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "successful_request_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "denied_request_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "failed_request_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "submitted_item_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "returned_item_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "CompanyUsageV1": { "required": [ "summary", "protected_content", "daily" ], "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/CompanyUsageSummaryV1" }, "protected_content": { "$ref": "#/components/schemas/CompanyProtectedContentUsageV1" }, "daily": { "maxItems": 90, "type": "array", "items": { "$ref": "#/components/schemas/CompanyDailyUsageV1" } } } }, "CreateCompanyCatalogItemRequestV1": { "required": [ "hph_item_code", "company_item_id", "alternate_company_item_id", "company_description", "reason" ], "type": "object", "properties": { "hph_item_code": { "maxLength": 10, "minLength": 0, "pattern": "^(?:[0-9]{3}[A-Z]{2}|010C |210C |275C1)[0-9]{4}[A-Z]?$", "type": "string" }, "company_item_id": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "alternate_company_item_id": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "company_description": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "reason": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] } }, "additionalProperties": false }, "CreateCompanyCatalogItemResponseV1": { "required": [ "contract_version", "operation_reference", "outcome", "item", "reused" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "operation_reference": { "type": "string" }, "outcome": { "type": "string" }, "item": { "$ref": "#/components/schemas/CompanyCatalogItemCreatedV1" }, "reused": { "type": "boolean" } } }, "CurrentActorResponseV1": { "required": [ "contract_version", "organization_id", "actor", "permissions", "evaluated_at" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "organization_id": { "maxLength": 255, "type": "string" }, "actor": { "$ref": "#/components/schemas/CurrentActorV1" }, "permissions": { "maxItems": 64, "type": "array", "items": { "type": "string" } }, "evaluated_at": { "type": "string", "format": "date-time" } } }, "CurrentActorV1": { "required": [ "type" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/CurrentActorV1CurrentUserActorV1" }, { "$ref": "#/components/schemas/CurrentActorV1CurrentPartnerApplicationActorV1" }, { "$ref": "#/components/schemas/CurrentActorV1CurrentCompanyCredentialActorV1" } ], "discriminator": { "propertyName": "type", "mapping": { "user": "#/components/schemas/CurrentActorV1CurrentUserActorV1", "partner_application": "#/components/schemas/CurrentActorV1CurrentPartnerApplicationActorV1", "company_credential": "#/components/schemas/CurrentActorV1CurrentCompanyCredentialActorV1" } } }, "CurrentActorV1CurrentCompanyCredentialActorV1": { "properties": { "type": { "enum": [ "company_credential" ], "type": "string" } } }, "CurrentActorV1CurrentPartnerApplicationActorV1": { "properties": { "type": { "enum": [ "partner_application" ], "type": "string" } } }, "CurrentActorV1CurrentUserActorV1": { "properties": { "type": { "enum": [ "user" ], "type": "string" } } }, "DirectCompanyItemMappingAvailableActionV1": { "required": [ "action", "title", "description", "operation_id", "method", "href", "request_body_required", "idempotency_key_required", "confirmation_required" ], "type": "object", "properties": { "action": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "operation_id": { "type": "string" }, "method": { "type": "string" }, "href": { "type": "string" }, "request_body_required": { "type": "boolean" }, "idempotency_key_required": { "type": "boolean" }, "confirmation_required": { "type": "boolean" } } }, "DirectCompanyItemMappingPreviousMappingV1": { "required": [ "mapping_revision", "hph_item_code" ], "type": "object", "properties": { "mapping_revision": { "maximum": 9223372036854776000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "hph_item_code": { "pattern": "^(?:[0-9]{3}[A-Z]{2}|010C |210C |275C1)[0-9]{4}[A-Z]?$", "type": "string" } } }, "DirectCompanyItemMappingValidationV1": { "required": [ "outcome", "warnings" ], "type": "object", "properties": { "outcome": { "type": "string" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/DirectCompanyItemMappingWarningV1" } } } }, "DirectCompanyItemMappingWarningV1": { "required": [ "code", "title", "description" ], "type": "object", "properties": { "code": { "maxLength": 128, "minLength": 0, "type": "string" }, "title": { "maxLength": 256, "minLength": 0, "type": "string" }, "description": { "maxLength": 1024, "minLength": 0, "type": "string" } } }, "EffectiveCapabilitiesResponse": { "required": [ "contract_version", "operations", "disclosure_profiles" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" } }, "disclosure_profiles": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalDisclosureProfile" } } } }, "ExternalDisclosureProfile": { "enum": [ "summary", "opaque_reference", "entitled_code", "transaction_resolution" ] }, "ExternalOperationStatus": { "enum": [ "submitted", "processing", "completed", "review_required", "rejected", "failed" ] }, "ExternalProblem": { "required": [ "type", "title", "status", "code", "correlation_id", "retryable" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "code": { "type": "string" }, "correlation_id": { "type": "string" }, "retryable": { "type": "boolean" }, "errors": { "type": [ "null", "object" ], "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "HphCategorizationV1": { "required": [ "category", "subcategory" ], "type": "object", "properties": { "category": { "type": [ "null", "string" ] }, "subcategory": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "HphItemAlternativeManufacturerV1": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "HphItemAlternativesByCompanyItemRequestV1": { "required": [ "company_item_id", "alternate_company_item_id", "include" ], "type": "object", "properties": { "company_item_id": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "alternate_company_item_id": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "include": { "maxItems": 1, "type": [ "null", "array" ], "items": { "type": "string" } } }, "additionalProperties": false }, "HphItemAlternativesRequestV1": { "required": [ "hph_item_code", "include" ], "type": "object", "properties": { "hph_item_code": { "maxLength": 10, "minLength": 0, "pattern": "^(?:[0-9]{3}[A-Z]{2}|010C |210C |275C1)[0-9]{4}[A-Z]?$", "type": "string" }, "include": { "maxItems": 1, "type": [ "null", "array" ], "items": { "type": "string" } } }, "additionalProperties": false }, "HphItemAlternativesResponseV1": { "required": [ "contract_version", "outcome", "alternatives", "notices" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "outcome": { "type": "string" }, "alternatives": { "maxItems": 49, "type": "array", "items": { "$ref": "#/components/schemas/HphItemAlternativeV1" } }, "notices": { "maxItems": 32, "type": "array", "items": { "$ref": "#/components/schemas/ResponseNoticeV1" } } }, "additionalProperties": false }, "HphItemAlternativeV1": { "required": [ "option_reference", "manufacturer", "description", "size", "manufacturer_part_number", "availability_status", "manufacturer_list_price" ], "type": "object", "properties": { "option_reference": { "maxLength": 4096, "minLength": 1, "type": "string" }, "manufacturer": { "$ref": "#/components/schemas/HphItemAlternativeManufacturerV1" }, "description": { "type": "string" }, "size": { "type": [ "null", "string" ] }, "manufacturer_part_number": { "type": [ "null", "string" ] }, "availability_status": { "pattern": "^[APD]$", "type": "string" }, "manufacturer_list_price": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ManufacturerListPriceV1" } ] } }, "additionalProperties": false }, "HphItemCatalogUsageRequestV1": { "required": [ "hph_item_code", "page_size", "cursor" ], "type": "object", "properties": { "hph_item_code": { "maxLength": 10, "minLength": 0, "pattern": "^(?:[0-9]{3}[A-Z]{2}|010C |210C |275C1)[0-9]{4}[A-Z]?$", "type": "string" }, "page_size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "cursor": { "maxLength": 64, "minLength": 0, "type": [ "null", "string" ] } }, "additionalProperties": false }, "HphItemCatalogUsageResponseV1": { "required": [ "contract_version", "hph_item_code", "company_item_count", "company_items", "next_cursor" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "hph_item_code": { "type": [ "null", "string" ] }, "company_item_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "company_items": { "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/CompanyItemCatalogUsageEntryV1" } }, "next_cursor": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "HphItemDetailsByCodeBatchRequestV1": { "required": [ "items" ], "type": "object", "properties": { "items": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/HphItemDetailsByCodeEntryV1" } } }, "additionalProperties": false }, "HphItemDetailsByCodeBatchResponseV1": { "required": [ "contract_version", "results" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "results": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/HphItemDetailsResultV1" } } }, "additionalProperties": false }, "HphItemDetailsByCodeEntryV1": { "required": [ "request_key", "hph_item_code" ], "type": "object", "properties": { "request_key": { "maxLength": 64, "minLength": 0, "type": [ "null", "string" ] }, "hph_item_code": { "maxLength": 10, "minLength": 0, "pattern": "^(?:[0-9]{3}[A-Z]{2}|010C |210C |275C1)[0-9]{4}[A-Z]?$", "type": "string" } }, "additionalProperties": false }, "HphItemDetailsResultV1": { "required": [ "outcome" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/HphItemDetailsResultV1AvailableHphItemDetailsResultV1" }, { "$ref": "#/components/schemas/HphItemDetailsResultV1NotFoundHphItemDetailsResultV1" }, { "$ref": "#/components/schemas/HphItemDetailsResultV1UnavailableHphItemDetailsResultV1" } ], "discriminator": { "propertyName": "outcome", "mapping": { "available": "#/components/schemas/HphItemDetailsResultV1AvailableHphItemDetailsResultV1", "not_found_or_concealed": "#/components/schemas/HphItemDetailsResultV1NotFoundHphItemDetailsResultV1", "temporarily_unavailable": "#/components/schemas/HphItemDetailsResultV1UnavailableHphItemDetailsResultV1" } } }, "HphItemDetailsResultV1AvailableHphItemDetailsResultV1": { "required": [ "item", "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "available" ], "type": "string" }, "item": { "$ref": "#/components/schemas/HphItemDetailsV1" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "HphItemDetailsResultV1NotFoundHphItemDetailsResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "not_found_or_concealed" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "HphItemDetailsResultV1UnavailableHphItemDetailsResultV1": { "required": [ "request_index", "request_key" ], "properties": { "outcome": { "enum": [ "temporarily_unavailable" ], "type": "string" }, "request_index": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "request_key": { "type": [ "null", "string" ] } } }, "HphItemDetailsV1": { "required": [ "item_ids", "company_item_count", "lifecycle", "availability_status", "size", "descriptions", "manufacturer", "categorization", "weight" ], "type": "object", "properties": { "item_ids": { "$ref": "#/components/schemas/HphItemIdentifiersV1" }, "company_item_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "lifecycle": { "type": "string" }, "availability_status": { "type": "string" }, "size": { "type": [ "null", "string" ] }, "descriptions": { "$ref": "#/components/schemas/ItemDescriptionsV1" }, "manufacturer": { "$ref": "#/components/schemas/ManufacturerV1" }, "categorization": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/HphCategorizationV1" } ] }, "weight": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MeasurementV1" } ] } }, "additionalProperties": false }, "HphItemIdentifiersV1": { "required": [ "hph_item_code", "manufacturer_part_number", "manufacturer_order_number", "manufacturer_upc" ], "type": "object", "properties": { "hph_item_code": { "type": [ "null", "string" ] }, "manufacturer_part_number": { "type": [ "null", "string" ] }, "manufacturer_order_number": { "type": [ "null", "string" ] }, "manufacturer_upc": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "ItemDescriptionsV1": { "required": [ "company", "hph_long", "hph_short", "manufacturer" ], "type": "object", "properties": { "company": { "type": [ "null", "string" ] }, "hph_long": { "type": [ "null", "string" ] }, "hph_short": { "type": [ "null", "string" ] }, "manufacturer": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "ItemIdentifiersV1": { "required": [ "hph_item_code", "company_item_id", "company_item_alt_id", "manufacturer_part_number", "manufacturer_order_number", "manufacturer_upc" ], "type": "object", "properties": { "hph_item_code": { "type": [ "null", "string" ] }, "company_item_id": { "type": [ "null", "string" ] }, "company_item_alt_id": { "type": [ "null", "string" ] }, "manufacturer_part_number": { "type": [ "null", "string" ] }, "manufacturer_order_number": { "type": [ "null", "string" ] }, "manufacturer_upc": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "LaborHoursFilterV1": { "required": [ "provider", "method", "selection" ], "type": "object", "properties": { "provider": { "maxLength": 128, "minLength": 0, "type": [ "null", "string" ] }, "method": { "maxLength": 128, "minLength": 0, "type": [ "null", "string" ] }, "selection": { "maxLength": 32, "minLength": 0, "type": [ "null", "string" ] } }, "additionalProperties": false }, "LaborHourV1": { "required": [ "hph_labor_code", "provider", "method", "description", "hours", "unit_of_measure", "effective_date", "is_default" ], "type": "object", "properties": { "hph_labor_code": { "type": "string" }, "provider": { "type": "string" }, "method": { "type": "string" }, "description": { "type": "string" }, "hours": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$", "type": [ "number", "string" ], "format": "double" }, "unit_of_measure": { "type": "string" }, "effective_date": { "type": "string", "format": "date" }, "is_default": { "type": "boolean" } }, "additionalProperties": false }, "ManufacturerListPriceV1": { "required": [ "price_sheet_skey", "price", "currency", "unit_of_measure", "effective_date", "price_sheet_number", "price_sheet_name" ], "type": "object", "properties": { "price_sheet_skey": { "type": "string", "format": "uuid" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$", "type": [ "number", "string" ], "format": "double" }, "currency": { "type": "string" }, "unit_of_measure": { "type": "string" }, "effective_date": { "type": "string", "format": "date" }, "price_sheet_number": { "type": "string" }, "price_sheet_name": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "ManufacturerV1": { "required": [ "manufacturer_id", "name", "short_name" ], "type": "object", "properties": { "manufacturer_id": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "short_name": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "MaterialCatalogSearchCountV1": { "required": [ "relation", "value" ], "type": "object", "properties": { "relation": { "type": "string" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" } }, "additionalProperties": false }, "MaterialCatalogSearchDescriptionV1": { "required": [ "value", "provenance" ], "type": "object", "properties": { "value": { "type": "string" }, "provenance": { "type": "string" } }, "additionalProperties": false }, "MaterialCatalogSearchItemV1": { "required": [ "item_type" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/MaterialCatalogSearchItemV1CompanyMaterialCatalogSearchItemV1" }, { "$ref": "#/components/schemas/MaterialCatalogSearchItemV1HphMaterialCatalogSearchItemV1" } ], "discriminator": { "propertyName": "item_type", "mapping": { "company_item": "#/components/schemas/MaterialCatalogSearchItemV1CompanyMaterialCatalogSearchItemV1", "hph_item": "#/components/schemas/MaterialCatalogSearchItemV1HphMaterialCatalogSearchItemV1" } } }, "MaterialCatalogSearchItemV1CompanyMaterialCatalogSearchItemV1": { "required": [ "item_skey", "company_item_id", "descriptions", "manufacturer_name", "manufacturer_part_number", "manufacturer_order_number", "upc", "gtin" ], "properties": { "item_type": { "enum": [ "company_item" ], "type": "string" }, "item_skey": { "type": "string", "format": "uuid" }, "company_item_id": { "type": [ "null", "string" ] }, "descriptions": { "maxItems": 8, "type": "array", "items": { "$ref": "#/components/schemas/MaterialCatalogSearchDescriptionV1" } }, "manufacturer_name": { "type": [ "null", "string" ] }, "manufacturer_part_number": { "type": [ "null", "string" ] }, "manufacturer_order_number": { "type": [ "null", "string" ] }, "upc": { "type": [ "null", "string" ] }, "gtin": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "MaterialCatalogSearchItemV1HphMaterialCatalogSearchItemV1": { "required": [ "hph_item_code", "descriptions", "manufacturer_name", "manufacturer_part_number", "manufacturer_order_number", "upc", "gtin" ], "properties": { "item_type": { "enum": [ "hph_item" ], "type": "string" }, "hph_item_code": { "type": "string" }, "descriptions": { "maxItems": 8, "type": "array", "items": { "$ref": "#/components/schemas/MaterialCatalogSearchDescriptionV1" } }, "manufacturer_name": { "type": [ "null", "string" ] }, "manufacturer_part_number": { "type": [ "null", "string" ] }, "manufacturer_order_number": { "type": [ "null", "string" ] }, "upc": { "type": [ "null", "string" ] }, "gtin": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "MaterialCatalogSearchResponseV1": { "required": [ "contract_version", "search_reference", "outcome", "source", "count", "items", "next_cursor" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "search_reference": { "type": "string" }, "outcome": { "type": "string" }, "source": { "type": "string" }, "count": { "$ref": "#/components/schemas/MaterialCatalogSearchCountV1" }, "items": { "maxItems": 50, "type": "array", "items": { "$ref": "#/components/schemas/MaterialCatalogSearchItemV1" } }, "next_cursor": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "MaterialVendorCollectionResponseV1": { "required": [ "contract_version", "evaluated_at", "vendors", "vendor_count" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "evaluated_at": { "type": "string", "format": "date-time" }, "vendors": { "maxItems": 50, "type": "array", "items": { "$ref": "#/components/schemas/MaterialVendorV1" } }, "vendor_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "MaterialVendorV1": { "required": [ "vendor_skey", "code", "name", "vendor_type", "status", "transaction_pipeline_available", "logo_url", "branch_location", "address", "contact", "account_count" ], "type": "object", "properties": { "vendor_skey": { "maxLength": 255, "type": "string" }, "code": { "maxLength": 255, "type": [ "null", "string" ] }, "name": { "maxLength": 255, "type": "string" }, "vendor_type": { "maxLength": 255, "type": "string" }, "status": { "type": "string" }, "transaction_pipeline_available": { "type": "boolean" }, "logo_url": { "maxLength": 2048, "type": [ "null", "string" ] }, "branch_location": { "maxLength": 255, "type": [ "null", "string" ] }, "address": { "$ref": "#/components/schemas/VendorAddressV1" }, "contact": { "$ref": "#/components/schemas/VendorContactV1" }, "account_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "MeasurementV1": { "required": [ "value", "unit_of_measure" ], "type": "object", "properties": { "value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$", "type": [ "number", "string" ], "format": "double" }, "unit_of_measure": { "type": "string" } }, "additionalProperties": false }, "ResponseNoticeV1": { "required": [ "code", "title", "description", "target", "provider", "method" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "target": { "type": "string" }, "provider": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "RestoreDirectCompanyItemMappingRequestV1": { "required": [ "company_item_id", "restore_from_revision", "expected_mapping_revision" ], "type": "object", "properties": { "company_item_id": { "maxLength": 255, "minLength": 1, "type": "string" }, "restore_from_revision": { "maximum": 9223372036854776000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "expected_mapping_revision": { "maximum": 9223372036854776000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, "additionalProperties": false }, "RestoreEmptyCompanyItemMappingResponseV1": { "required": [ "operation_reference", "item_skey", "company_item_id", "transition", "mapping_status", "restored_from_revision", "mapping_revision", "reused", "available_actions" ], "type": "object", "properties": { "operation_reference": { "type": "string" }, "item_skey": { "type": "string", "format": "uuid" }, "company_item_id": { "maxLength": 255, "minLength": 0, "type": "string" }, "transition": { "type": "string" }, "mapping_status": { "type": "string" }, "restored_from_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "reused": { "type": "boolean" }, "available_actions": { "maxItems": 4, "type": "array", "items": { "$ref": "#/components/schemas/DirectCompanyItemMappingAvailableActionV1" } } } }, "SelectHphItemAlternativeRequestV1": { "required": [ "option_reference", "company_item_id", "alternate_company_item_id", "company_description", "reason", "confirmed" ], "type": "object", "properties": { "option_reference": { "maxLength": 4096, "minLength": 1, "type": "string" }, "company_item_id": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "alternate_company_item_id": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "company_description": { "maxLength": 1024, "minLength": 0, "type": [ "null", "string" ] }, "reason": { "maxLength": 512, "minLength": 1, "type": "string" }, "confirmed": { "type": "boolean" } }, "additionalProperties": false }, "SelectHphItemAlternativeResponseV1": { "required": [ "contract_version", "operation_reference", "outcome", "item_skey", "company_item_id", "catalog_revision", "reused" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "operation_reference": { "type": "string" }, "outcome": { "type": "string" }, "item_skey": { "type": "string", "format": "uuid" }, "company_item_id": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] }, "catalog_revision": { "maximum": 9223372036854776000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "reused": { "type": "boolean" } }, "additionalProperties": false }, "SetDirectCompanyItemMappingRequestV1": { "required": [ "company_item_id", "hph_item_code", "expected_mapping_revision", "reason" ], "type": "object", "properties": { "company_item_id": { "maxLength": 255, "minLength": 1, "type": "string" }, "hph_item_code": { "maxLength": 10, "minLength": 0, "pattern": "^(?:[0-9]{3}[A-Z]{2}|010C |210C |275C1)[0-9]{4}[A-Z]?$", "type": "string" }, "expected_mapping_revision": { "maximum": 9223372036854776000, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "reason": { "maxLength": 512, "minLength": 0, "type": [ "null", "string" ] } }, "additionalProperties": false }, "SetDirectCompanyItemMappingResponseV1": { "required": [ "operation_reference", "item_skey", "company_item_id", "transition", "mapping_status", "previous_mapping", "mapping_revision", "hph_item_code", "reused", "validation", "available_actions" ], "type": "object", "properties": { "operation_reference": { "maxLength": 128, "minLength": 0, "type": "string" }, "item_skey": { "type": "string", "format": "uuid" }, "company_item_id": { "maxLength": 255, "minLength": 0, "type": "string" }, "transition": { "type": "string" }, "mapping_status": { "type": "string" }, "previous_mapping": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DirectCompanyItemMappingPreviousMappingV1" } ] }, "mapping_revision": { "maximum": 9223372036854776000, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "hph_item_code": { "pattern": "^(?:[0-9]{3}[A-Z]{2}|010C |210C |275C1)[0-9]{4}[A-Z]?$", "type": "string" }, "reused": { "type": "boolean" }, "validation": { "$ref": "#/components/schemas/DirectCompanyItemMappingValidationV1" }, "available_actions": { "maxItems": 4, "type": "array", "items": { "$ref": "#/components/schemas/DirectCompanyItemMappingAvailableActionV1" } } } }, "SingleItemAcceptForReviewRequestV1": { "required": [ "candidate_token", "result_revision", "expected_mapping_revision" ], "type": "object", "properties": { "candidate_token": { "maxLength": 64, "minLength": 1, "type": "string" }, "result_revision": { "maximum": 3, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "expected_mapping_revision": { "maximum": 9223372036854775807, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, "additionalProperties": false }, "SingleItemCandidateExpansionRequestV1": { "required": [ "result_revision" ], "type": "object", "properties": { "result_revision": { "maximum": 3, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, "additionalProperties": false }, "SingleItemIgnoreDecisionRequestV1": { "required": [ "result_revision" ], "type": "object", "properties": { "result_revision": { "maximum": 3, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, "additionalProperties": false }, "SingleItemIgnoreDecisionResponseV1": { "required": [ "contract_version", "operation_reference", "action_reference", "status", "result_revision", "mapping_revision", "completed_at", "reused" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "operation_reference": { "maxLength": 128, "minLength": 1, "type": "string" }, "action_reference": { "maxLength": 128, "minLength": 1, "type": "string" }, "status": { "enum": [ "ignored" ], "type": "string" }, "result_revision": { "maximum": 3, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "mapping_revision": { "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "completed_at": { "type": "string", "format": "date-time" }, "reused": { "type": "boolean" } } }, "SingleItemMappingAvailableActionV1": { "required": [ "action", "title", "description", "operation_id", "method", "href", "request_body_required", "idempotency_key_required", "confirmation_required" ], "type": "object", "properties": { "action": { "maxLength": 64, "minLength": 1, "enum": [ "get_current_result", "expand_candidates", "accept_for_review", "release_to_production", "ignore" ], "type": "string" }, "title": { "maxLength": 128, "minLength": 1, "type": "string" }, "description": { "maxLength": 512, "minLength": 1, "type": "string" }, "operation_id": { "maxLength": 128, "minLength": 1, "enum": [ "GetSingleItemMappingCurrentResult", "ExpandSingleItemMappingCandidates", "AcceptSingleItemMappingForReview", "ReleaseSingleItemMappingToProduction", "IgnoreSingleItemMapping" ], "type": "string" }, "method": { "maxLength": 8, "minLength": 1, "enum": [ "GET", "POST" ], "type": "string" }, "href": { "maxLength": 512, "minLength": 1, "type": "string" }, "request_body_required": { "type": "boolean" }, "idempotency_key_required": { "type": "boolean" }, "confirmation_required": { "type": "boolean" } } }, "SingleItemMappingCandidateV1": { "required": [ "candidate_token", "rank", "manufacturer", "description", "product", "material", "size", "item_status", "match_strength", "evidence", "warnings" ], "type": "object", "properties": { "candidate_token": { "type": "string" }, "rank": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "manufacturer": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "product": { "type": [ "null", "string" ] }, "material": { "type": [ "null", "string" ] }, "size": { "type": [ "null", "string" ] }, "item_status": { "type": "string" }, "match_strength": { "type": "string" }, "evidence": { "type": "array", "items": { "$ref": "#/components/schemas/SingleItemMappingEvidenceV1" } }, "warnings": { "type": "array", "items": { "type": "string" } } } }, "SingleItemMappingCurrentResultResponseV1": { "required": [ "contract_version", "operation_reference", "correlation_id", "company_item_id", "result_revision", "mapping_revision", "status", "reason_codes", "candidates", "next_actions", "available_actions", "completed_at", "reused" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "operation_reference": { "maxLength": 128, "minLength": 0, "type": "string" }, "correlation_id": { "type": "string" }, "company_item_id": { "type": "string" }, "result_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "mapping_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "status": { "$ref": "#/components/schemas/ExternalOperationStatus" }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "candidates": { "maxItems": 25, "type": "array", "items": { "$ref": "#/components/schemas/SingleItemMappingCandidateV1" } }, "next_actions": { "type": "array", "items": { "type": "string" } }, "available_actions": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/SingleItemMappingAvailableActionV1" } }, "completed_at": { "type": "string", "format": "date-time" }, "reused": { "type": "boolean" } } }, "SingleItemMappingEvidenceV1": { "required": [ "type", "outcome" ], "type": "object", "properties": { "type": { "type": "string" }, "outcome": { "type": "string" } } }, "SingleItemMappingRequestV1": { "required": [ "company_item_id", "description" ], "type": "object", "properties": { "company_item_id": { "maxLength": 255, "minLength": 1, "type": "string" }, "description": { "maxLength": 4096, "minLength": 1, "type": "string" }, "long_description": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "company_item_alt_id": { "maxLength": 255, "minLength": 0, "type": [ "null", "string" ] }, "hph_item_code": { "maxLength": 128, "minLength": 0, "type": [ "null", "string" ] }, "size": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "mfr_name": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "mfr_part": { "maxLength": 255, "minLength": 0, "type": [ "null", "string" ] }, "mfr_order": { "maxLength": 255, "minLength": 0, "type": [ "null", "string" ] }, "mfr_upc": { "maxLength": 255, "minLength": 0, "type": [ "null", "string" ] }, "material": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "product": { "maxLength": 4096, "minLength": 0, "type": [ "null", "string" ] }, "weight": { "multipleOf": 0.000001, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$", "type": [ "null", "number", "string" ], "format": "double" }, "list_price": { "multipleOf": 0.0001, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d\u002B)?$", "type": [ "null", "number", "string" ], "format": "double" } }, "additionalProperties": false }, "SingleItemMappingResponseV1": { "required": [ "contract_version", "operation_reference", "correlation_id", "company_item_id", "result_revision", "status", "reason_codes", "candidates", "next_action", "available_actions", "completed_at", "reused" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "operation_reference": { "type": "string" }, "correlation_id": { "type": "string" }, "company_item_id": { "type": "string" }, "result_revision": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "status": { "$ref": "#/components/schemas/ExternalOperationStatus" }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "candidates": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/SingleItemMappingCandidateV1" } }, "next_action": { "type": "string" }, "available_actions": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/SingleItemMappingAvailableActionV1" } }, "completed_at": { "type": "string", "format": "date-time" }, "reused": { "type": "boolean" } } }, "SingleItemProductionReleaseRequestV1": { "required": [ "candidate_token", "result_revision", "expected_mapping_revision" ], "type": "object", "properties": { "candidate_token": { "maxLength": 64, "minLength": 1, "type": "string" }, "result_revision": { "maximum": 3, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "expected_mapping_revision": { "maximum": 9223372036854775806, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, "additionalProperties": false }, "SingleItemProductionReleaseResponseV1": { "required": [ "contract_version", "operation_reference", "action_reference", "status", "result_revision", "mapping_revision", "completed_at", "reused" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "operation_reference": { "maxLength": 128, "minLength": 0, "type": "string" }, "action_reference": { "maxLength": 128, "minLength": 0, "type": "string" }, "status": { "enum": [ "released_to_production" ], "type": "string" }, "result_revision": { "maximum": 3, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "mapping_revision": { "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "completed_at": { "type": "string", "format": "date-time" }, "reused": { "type": "boolean" } } }, "SingleItemReviewProposalResponseV1": { "required": [ "contract_version", "operation_reference", "action_reference", "status", "result_revision", "mapping_revision", "completed_at", "reused" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "operation_reference": { "maxLength": 128, "minLength": 1, "type": "string" }, "action_reference": { "maxLength": 128, "minLength": 1, "type": "string" }, "status": { "enum": [ "review_proposed" ], "type": "string" }, "result_revision": { "maximum": 3, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "mapping_revision": { "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "completed_at": { "type": "string", "format": "date-time" }, "reused": { "type": "boolean" } } }, "VendorAccountCollectionResponseV1": { "required": [ "contract_version", "evaluated_at", "vendor_skey", "accounts", "account_count" ], "type": "object", "properties": { "contract_version": { "type": "string" }, "evaluated_at": { "type": "string", "format": "date-time" }, "vendor_skey": { "maxLength": 255, "type": "string" }, "accounts": { "maxItems": 50, "type": "array", "items": { "$ref": "#/components/schemas/VendorAccountV1" } }, "account_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "VendorAccountV1": { "required": [ "vendor_account_skey", "account_number", "name" ], "type": "object", "properties": { "vendor_account_skey": { "maxLength": 255, "type": "string" }, "account_number": { "maxLength": 255, "type": [ "null", "string" ] }, "name": { "maxLength": 255, "type": "string" } } }, "VendorAddressV1": { "required": [ "address_1", "address_2", "address_3", "city", "state", "postal_code" ], "type": "object", "properties": { "address_1": { "type": [ "null", "string" ] }, "address_2": { "type": [ "null", "string" ] }, "address_3": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] } } }, "VendorContactV1": { "required": [ "telephone", "quote_request_email", "website" ], "type": "object", "properties": { "telephone": { "type": [ "null", "string" ] }, "quote_request_email": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] } } } } } }