Appearance

Scenario API Reference ​

Complete API reference for Scenario operations.

Related: API Guide | All Resources

Scenario​

Scenario_CmicOutput​

POST
/scenario/CMIC

Scenario_CmicOutput

Authorizations​

apiKeyHeader
Type
API Key (header: Ocp-Apim-Subscription-Key)
or
apiKeyQuery
Type
API Key (query: subscription-key)

Parameters​

Header Parameters

Authorization

access token

Type
string

Query Parameters

bidScenarioId*

Format - uuid.

Type
string
Required
Format
"uuid"

Responses​

OK

JSON
[
{
"J3": "string",
"PhaseCode": "string",
"PhaseCodeDescription": "string",
"UnitOfMeasure": "string",
"Quantity": 0,
"CategoryUnitOfMeasure": "string",
"LaborHours": 0,
"DollarAmount": 0
}
]

Get all items that are marked as 'Labor' for the specified Scenario.​

POST
/scenario/labor

Get all items that are marked as 'Labor' for the specified Scenario.

Authorizations​

apiKeyHeader
Type
API Key (header: Ocp-Apim-Subscription-Key)
or
apiKeyQuery
Type
API Key (query: subscription-key)

Parameters​

Header Parameters

Authorization

access token

Type
string

Query Parameters

request.bidScenarioId

Format - uuid.

Type
string
Format
"uuid"

Responses​

OK

JSON
{
"Items": [
{
"ChildrenCount": 0,
"HasErrors": true,
"CorrelationKeys": [
"00000000-0000-0000-0000-000000000000"
],
"PartNumber": "string",
"EstimatedUnit": "string",
"Pieces": 0,
"IsOn": true,
"PriceFormula": "string",
"OrderFormula": "string",
"Description": "string",
"Quantity": 0,
"WastePercent": 0,
"WasteQuantity": 0,
"CostPerCrewday": 0,
"CostPerEU": 0,
"RawOrderQuantity": 0,
"OrderQuantityAdd": 0,
"OrderQuantity": 0,
"OrderUnit": "string",
"CostPerHour": 0,
"UnitPrice": 0,
"DatabaseUnitPrice": 0,
"PriceQuantity": 0,
"PriceUnit": "string",
"GrossPrice": 0,
"NetPlusMarkups": 0,
"NetCost": 0,
"ProductionRate": 0,
"EffectiveProductionRate": 0,
"ProductionMultiplier": 0,
"AddHours": 0,
"Minutes": 0,
"Hours": 0,
"Mandays": 0,
"Crewdays": 0,
"EUPerMinute": 0,
"EUPerHour": 0,
"HoursPerEU": 0,
"MinutesPerEU": 0,
"CostPerManday": 0,
"CrewSize": 0,
"AltQuantity": 0,
"AU": "string",
"AUPerHour": 0,
"AUPerManday": 0,
"AUPerCrewday": 0,
"CostPerAU": 0,
"UserCodeCode": "string",
"UserCodeDescription": "string",
"UserCode": "string",
"User1": "string",
"User2": "string",
"User1Description": "string",
"User2Description": "string",
"User3": "string",
"User4": "string",
"RoundOrderQuantity": true,
"ConditionName": "string",
"PageName": "string",
"SectionName": "string",
"ScenarioName": "string",
"BidName": "string",
"ItemName": "string",
"ItemCode": "string",
"AlertErrors": [
"string"
],
"IsMiscItem": true,
"CostType": "string",
"IndustryID": "string",
"ActualWasteQuantity": 0,
"Type": "string",
"FromSchedule": "string",
"User1Consolidated": "string",
"User2Consolidated": "string",
"User3Consolidated": "string",
"User4Consolidated": "string",
"SubdivisionDescription": "string",
"P1": "string",
"P2": "string",
"P3": "string",
"PageNumberAndDescription": "string",
"S1": "string",
"S2": "string",
"S3": "string",
"SectionNumberAndDescription": "string",
"C1": "string",
"C2": "string",
"C3": "string",
"C4": "string",
"C5": "string",
"C6": "string",
"J1": "string",
"J2": "string",
"J3": "string",
"J4": "string",
"J5": "string",
"J6": "string",
"J7": "string",
"J8": "string"
}
],
"ServerName": "string",
"TenantId": "00000000-0000-0000-0000-000000000000",
"UserId": "00000000-0000-0000-0000-000000000000",
"ProcessingTime": 0,
"HasError": true,
"ErrorMessage": "string",
"StackTrace": "string",
"RequestKey": "string"
}

Get all items that are marked as 'Material' for the specified Scenario.​

POST
/scenario/material

Get all items that are marked as 'Material' for the specified Scenario.

Authorizations​

apiKeyHeader
Type
API Key (header: Ocp-Apim-Subscription-Key)
or
apiKeyQuery
Type
API Key (query: subscription-key)

Parameters​

Header Parameters

Authorization

access token

Type
string

Query Parameters

request.bidScenarioId

Format - uuid.

Type
string
Format
"uuid"

Responses​

OK

JSON
{
"Items": [
{
"ChildrenCount": 0,
"HasErrors": true,
"CorrelationKeys": [
"00000000-0000-0000-0000-000000000000"
],
"PartNumber": "string",
"EstimatedUnit": "string",
"Pieces": 0,
"IsOn": true,
"PriceFormula": "string",
"OrderFormula": "string",
"Description": "string",
"Quantity": 0,
"WastePercent": 0,
"WasteQuantity": 0,
"CostPerCrewday": 0,
"CostPerEU": 0,
"RawOrderQuantity": 0,
"OrderQuantityAdd": 0,
"OrderQuantity": 0,
"OrderUnit": "string",
"CostPerHour": 0,
"UnitPrice": 0,
"DatabaseUnitPrice": 0,
"PriceQuantity": 0,
"PriceUnit": "string",
"GrossPrice": 0,
"NetPlusMarkups": 0,
"NetCost": 0,
"ProductionRate": 0,
"EffectiveProductionRate": 0,
"ProductionMultiplier": 0,
"AddHours": 0,
"Minutes": 0,
"Hours": 0,
"Mandays": 0,
"Crewdays": 0,
"EUPerMinute": 0,
"EUPerHour": 0,
"HoursPerEU": 0,
"MinutesPerEU": 0,
"CostPerManday": 0,
"CrewSize": 0,
"AltQuantity": 0,
"AU": "string",
"AUPerHour": 0,
"AUPerManday": 0,
"AUPerCrewday": 0,
"CostPerAU": 0,
"UserCodeCode": "string",
"UserCodeDescription": "string",
"UserCode": "string",
"User1": "string",
"User2": "string",
"User1Description": "string",
"User2Description": "string",
"User3": "string",
"User4": "string",
"RoundOrderQuantity": true,
"ConditionName": "string",
"PageName": "string",
"SectionName": "string",
"ScenarioName": "string",
"BidName": "string",
"ItemName": "string",
"ItemCode": "string",
"AlertErrors": [
"string"
],
"IsMiscItem": true,
"CostType": "string",
"IndustryID": "string",
"ActualWasteQuantity": 0,
"Type": "string",
"FromSchedule": "string",
"User1Consolidated": "string",
"User2Consolidated": "string",
"User3Consolidated": "string",
"User4Consolidated": "string",
"SubdivisionDescription": "string",
"P1": "string",
"P2": "string",
"P3": "string",
"PageNumberAndDescription": "string",
"S1": "string",
"S2": "string",
"S3": "string",
"SectionNumberAndDescription": "string",
"C1": "string",
"C2": "string",
"C3": "string",
"C4": "string",
"C5": "string",
"C6": "string",
"J1": "string",
"J2": "string",
"J3": "string",
"J4": "string",
"J5": "string",
"J6": "string",
"J7": "string",
"J8": "string"
}
],
"ServerName": "string",
"TenantId": "00000000-0000-0000-0000-000000000000",
"UserId": "00000000-0000-0000-0000-000000000000",
"ProcessingTime": 0,
"HasError": true,
"ErrorMessage": "string",
"StackTrace": "string",
"RequestKey": "string"
}

Get all items that are marked as 'Other' for the specified Scenario.​

POST
/scenario/other

Get all items that are marked as 'Other' for the specified Scenario.

Authorizations​

apiKeyHeader
Type
API Key (header: Ocp-Apim-Subscription-Key)
or
apiKeyQuery
Type
API Key (query: subscription-key)

Parameters​

Header Parameters

Authorization

access token

Type
string

Query Parameters

request.bidScenarioId

Format - uuid.

Type
string
Format
"uuid"

Responses​

OK

JSON
{
"Items": [
{
"ChildrenCount": 0,
"HasErrors": true,
"CorrelationKeys": [
"00000000-0000-0000-0000-000000000000"
],
"PartNumber": "string",
"EstimatedUnit": "string",
"Pieces": 0,
"IsOn": true,
"PriceFormula": "string",
"OrderFormula": "string",
"Description": "string",
"Quantity": 0,
"WastePercent": 0,
"WasteQuantity": 0,
"CostPerCrewday": 0,
"CostPerEU": 0,
"RawOrderQuantity": 0,
"OrderQuantityAdd": 0,
"OrderQuantity": 0,
"OrderUnit": "string",
"CostPerHour": 0,
"UnitPrice": 0,
"DatabaseUnitPrice": 0,
"PriceQuantity": 0,
"PriceUnit": "string",
"GrossPrice": 0,
"NetPlusMarkups": 0,
"NetCost": 0,
"ProductionRate": 0,
"EffectiveProductionRate": 0,
"ProductionMultiplier": 0,
"AddHours": 0,
"Minutes": 0,
"Hours": 0,
"Mandays": 0,
"Crewdays": 0,
"EUPerMinute": 0,
"EUPerHour": 0,
"HoursPerEU": 0,
"MinutesPerEU": 0,
"CostPerManday": 0,
"CrewSize": 0,
"AltQuantity": 0,
"AU": "string",
"AUPerHour": 0,
"AUPerManday": 0,
"AUPerCrewday": 0,
"CostPerAU": 0,
"UserCodeCode": "string",
"UserCodeDescription": "string",
"UserCode": "string",
"User1": "string",
"User2": "string",
"User1Description": "string",
"User2Description": "string",
"User3": "string",
"User4": "string",
"RoundOrderQuantity": true,
"ConditionName": "string",
"PageName": "string",
"SectionName": "string",
"ScenarioName": "string",
"BidName": "string",
"ItemName": "string",
"ItemCode": "string",
"AlertErrors": [
"string"
],
"IsMiscItem": true,
"CostType": "string",
"IndustryID": "string",
"ActualWasteQuantity": 0,
"Type": "string",
"FromSchedule": "string",
"User1Consolidated": "string",
"User2Consolidated": "string",
"User3Consolidated": "string",
"User4Consolidated": "string",
"SubdivisionDescription": "string",
"P1": "string",
"P2": "string",
"P3": "string",
"PageNumberAndDescription": "string",
"S1": "string",
"S2": "string",
"S3": "string",
"SectionNumberAndDescription": "string",
"C1": "string",
"C2": "string",
"C3": "string",
"C4": "string",
"C5": "string",
"C6": "string",
"J1": "string",
"J2": "string",
"J3": "string",
"J4": "string",
"J5": "string",
"J6": "string",
"J7": "string",
"J8": "string"
}
],
"ServerName": "string",
"TenantId": "00000000-0000-0000-0000-000000000000",
"UserId": "00000000-0000-0000-0000-000000000000",
"ProcessingTime": 0,
"HasError": true,
"ErrorMessage": "string",
"StackTrace": "string",
"RequestKey": "string"
}

Get all items that are marked as 'Subcontracts' for the specified Scenario.​

POST
/scenario/subcontract

Get all items that are marked as 'Subcontracts' for the specified Scenario.

Authorizations​

apiKeyHeader
Type
API Key (header: Ocp-Apim-Subscription-Key)
or
apiKeyQuery
Type
API Key (query: subscription-key)

Parameters​

Header Parameters

Authorization

access token

Type
string

Query Parameters

request.bidScenarioId

Format - uuid.

Type
string
Format
"uuid"

Responses​

OK

JSON
{
"Items": [
{
"ChildrenCount": 0,
"HasErrors": true,
"CorrelationKeys": [
"00000000-0000-0000-0000-000000000000"
],
"PartNumber": "string",
"EstimatedUnit": "string",
"Pieces": 0,
"IsOn": true,
"PriceFormula": "string",
"OrderFormula": "string",
"Description": "string",
"Quantity": 0,
"WastePercent": 0,
"WasteQuantity": 0,
"CostPerCrewday": 0,
"CostPerEU": 0,
"RawOrderQuantity": 0,
"OrderQuantityAdd": 0,
"OrderQuantity": 0,
"OrderUnit": "string",
"CostPerHour": 0,
"UnitPrice": 0,
"DatabaseUnitPrice": 0,
"PriceQuantity": 0,
"PriceUnit": "string",
"GrossPrice": 0,
"NetPlusMarkups": 0,
"NetCost": 0,
"ProductionRate": 0,
"EffectiveProductionRate": 0,
"ProductionMultiplier": 0,
"AddHours": 0,
"Minutes": 0,
"Hours": 0,
"Mandays": 0,
"Crewdays": 0,
"EUPerMinute": 0,
"EUPerHour": 0,
"HoursPerEU": 0,
"MinutesPerEU": 0,
"CostPerManday": 0,
"CrewSize": 0,
"AltQuantity": 0,
"AU": "string",
"AUPerHour": 0,
"AUPerManday": 0,
"AUPerCrewday": 0,
"CostPerAU": 0,
"UserCodeCode": "string",
"UserCodeDescription": "string",
"UserCode": "string",
"User1": "string",
"User2": "string",
"User1Description": "string",
"User2Description": "string",
"User3": "string",
"User4": "string",
"RoundOrderQuantity": true,
"ConditionName": "string",
"PageName": "string",
"SectionName": "string",
"ScenarioName": "string",
"BidName": "string",
"ItemName": "string",
"ItemCode": "string",
"AlertErrors": [
"string"
],
"IsMiscItem": true,
"CostType": "string",
"IndustryID": "string",
"ActualWasteQuantity": 0,
"Type": "string",
"FromSchedule": "string",
"User1Consolidated": "string",
"User2Consolidated": "string",
"User3Consolidated": "string",
"User4Consolidated": "string",
"SubdivisionDescription": "string",
"P1": "string",
"P2": "string",
"P3": "string",
"PageNumberAndDescription": "string",
"S1": "string",
"S2": "string",
"S3": "string",
"SectionNumberAndDescription": "string",
"C1": "string",
"C2": "string",
"C3": "string",
"C4": "string",
"C5": "string",
"C6": "string",
"J1": "string",
"J2": "string",
"J3": "string",
"J4": "string",
"J5": "string",
"J6": "string",
"J7": "string",
"J8": "string"
}
],
"ServerName": "string",
"TenantId": "00000000-0000-0000-0000-000000000000",
"UserId": "00000000-0000-0000-0000-000000000000",
"ProcessingTime": 0,
"HasError": true,
"ErrorMessage": "string",
"StackTrace": "string",
"RequestKey": "string"
}

Scenario_NoneLabor​

POST
/scenario/nonlabor

Scenario_NoneLabor

Authorizations​

apiKeyHeader
Type
API Key (header: Ocp-Apim-Subscription-Key)
or
apiKeyQuery
Type
API Key (query: subscription-key)

Parameters​

Header Parameters

Authorization

access token

Type
string

Query Parameters

request.bidScenarioId

Format - uuid.

Type
string
Format
"uuid"

Responses​

OK

JSON
{
"Items": [
{
"ChildrenCount": 0,
"HasErrors": true,
"CorrelationKeys": [
"00000000-0000-0000-0000-000000000000"
],
"PartNumber": "string",
"EstimatedUnit": "string",
"Pieces": 0,
"IsOn": true,
"PriceFormula": "string",
"OrderFormula": "string",
"Description": "string",
"Quantity": 0,
"WastePercent": 0,
"WasteQuantity": 0,
"CostPerCrewday": 0,
"CostPerEU": 0,
"RawOrderQuantity": 0,
"OrderQuantityAdd": 0,
"OrderQuantity": 0,
"OrderUnit": "string",
"CostPerHour": 0,
"UnitPrice": 0,
"DatabaseUnitPrice": 0,
"PriceQuantity": 0,
"PriceUnit": "string",
"GrossPrice": 0,
"NetPlusMarkups": 0,
"NetCost": 0,
"ProductionRate": 0,
"EffectiveProductionRate": 0,
"ProductionMultiplier": 0,
"AddHours": 0,
"Minutes": 0,
"Hours": 0,
"Mandays": 0,
"Crewdays": 0,
"EUPerMinute": 0,
"EUPerHour": 0,
"HoursPerEU": 0,
"MinutesPerEU": 0,
"CostPerManday": 0,
"CrewSize": 0,
"AltQuantity": 0,
"AU": "string",
"AUPerHour": 0,
"AUPerManday": 0,
"AUPerCrewday": 0,
"CostPerAU": 0,
"UserCodeCode": "string",
"UserCodeDescription": "string",
"UserCode": "string",
"User1": "string",
"User2": "string",
"User1Description": "string",
"User2Description": "string",
"User3": "string",
"User4": "string",
"RoundOrderQuantity": true,
"ConditionName": "string",
"PageName": "string",
"SectionName": "string",
"ScenarioName": "string",
"BidName": "string",
"ItemName": "string",
"ItemCode": "string",
"AlertErrors": [
"string"
],
"IsMiscItem": true,
"CostType": "string",
"IndustryID": "string",
"ActualWasteQuantity": 0,
"Type": "string",
"FromSchedule": "string",
"User1Consolidated": "string",
"User2Consolidated": "string",
"User3Consolidated": "string",
"User4Consolidated": "string",
"SubdivisionDescription": "string",
"P1": "string",
"P2": "string",
"P3": "string",
"PageNumberAndDescription": "string",
"S1": "string",
"S2": "string",
"S3": "string",
"SectionNumberAndDescription": "string",
"C1": "string",
"C2": "string",
"C3": "string",
"C4": "string",
"C5": "string",
"C6": "string",
"J1": "string",
"J2": "string",
"J3": "string",
"J4": "string",
"J5": "string",
"J6": "string",
"J7": "string",
"J8": "string"
}
],
"ServerName": "string",
"TenantId": "00000000-0000-0000-0000-000000000000",
"UserId": "00000000-0000-0000-0000-000000000000",
"ProcessingTime": 0,
"HasError": true,
"ErrorMessage": "string",
"StackTrace": "string",
"RequestKey": "string"
}

Get all items that are marked as 'Equipment' for the specified Scenario.​

POST
/scenario/equipment

Get all items that are marked as 'Equipment' for the specified Scenario.

Authorizations​

apiKeyHeader
Type
API Key (header: Ocp-Apim-Subscription-Key)
or
apiKeyQuery
Type
API Key (query: subscription-key)

Parameters​

Header Parameters

Authorization

access token

Type
string

Query Parameters

request.bidScenarioId

Format - uuid.

Type
string
Format
"uuid"

Responses​

OK

JSON
{
"Items": [
{
"ChildrenCount": 0,
"HasErrors": true,
"CorrelationKeys": [
"00000000-0000-0000-0000-000000000000"
],
"PartNumber": "string",
"EstimatedUnit": "string",
"Pieces": 0,
"IsOn": true,
"PriceFormula": "string",
"OrderFormula": "string",
"Description": "string",
"Quantity": 0,
"WastePercent": 0,
"WasteQuantity": 0,
"CostPerCrewday": 0,
"CostPerEU": 0,
"RawOrderQuantity": 0,
"OrderQuantityAdd": 0,
"OrderQuantity": 0,
"OrderUnit": "string",
"CostPerHour": 0,
"UnitPrice": 0,
"DatabaseUnitPrice": 0,
"PriceQuantity": 0,
"PriceUnit": "string",
"GrossPrice": 0,
"NetPlusMarkups": 0,
"NetCost": 0,
"ProductionRate": 0,
"EffectiveProductionRate": 0,
"ProductionMultiplier": 0,
"AddHours": 0,
"Minutes": 0,
"Hours": 0,
"Mandays": 0,
"Crewdays": 0,
"EUPerMinute": 0,
"EUPerHour": 0,
"HoursPerEU": 0,
"MinutesPerEU": 0,
"CostPerManday": 0,
"CrewSize": 0,
"AltQuantity": 0,
"AU": "string",
"AUPerHour": 0,
"AUPerManday": 0,
"AUPerCrewday": 0,
"CostPerAU": 0,
"UserCodeCode": "string",
"UserCodeDescription": "string",
"UserCode": "string",
"User1": "string",
"User2": "string",
"User1Description": "string",
"User2Description": "string",
"User3": "string",
"User4": "string",
"RoundOrderQuantity": true,
"ConditionName": "string",
"PageName": "string",
"SectionName": "string",
"ScenarioName": "string",
"BidName": "string",
"ItemName": "string",
"ItemCode": "string",
"AlertErrors": [
"string"
],
"IsMiscItem": true,
"CostType": "string",
"IndustryID": "string",
"ActualWasteQuantity": 0,
"Type": "string",
"FromSchedule": "string",
"User1Consolidated": "string",
"User2Consolidated": "string",
"User3Consolidated": "string",
"User4Consolidated": "string",
"SubdivisionDescription": "string",
"P1": "string",
"P2": "string",
"P3": "string",
"PageNumberAndDescription": "string",
"S1": "string",
"S2": "string",
"S3": "string",
"SectionNumberAndDescription": "string",
"C1": "string",
"C2": "string",
"C3": "string",
"C4": "string",
"C5": "string",
"C6": "string",
"J1": "string",
"J2": "string",
"J3": "string",
"J4": "string",
"J5": "string",
"J6": "string",
"J7": "string",
"J8": "string"
}
],
"ServerName": "string",
"TenantId": "00000000-0000-0000-0000-000000000000",
"UserId": "00000000-0000-0000-0000-000000000000",
"ProcessingTime": 0,
"HasError": true,
"ErrorMessage": "string",
"StackTrace": "string",
"RequestKey": "string"
}

Get all sections for the specified Scenario.​

POST
/scenario/sections

Get all sections for the specified Scenario.

Authorizations​

apiKeyHeader
Type
API Key (header: Ocp-Apim-Subscription-Key)
or
apiKeyQuery
Type
API Key (query: subscription-key)

Parameters​

Header Parameters

Authorization

access token

Type
string

Query Parameters

request.bidScenarioId

Format - uuid.

Type
string
Format
"uuid"

Responses​

OK

JSON
{
"J1": "string",
"J2": "string",
"J3": "string",
"J4": "string",
"J5": "string",
"J6": "string",
"J7": "string",
"J8": "string",
"ReportId": "00000000-0000-0000-0000-000000000000",
"ReportSchemaType": "string",
"PageInfo": "string",
"BidName": "string",
"Title": "string",
"Crewdays": 0,
"GrossPrice": 0,
"HasErrors": true,
"Hours": 0,
"Mandays": 0,
"NetCost": 0,
"Sections": [
{
"CorrelationKey": "00000000-0000-0000-0000-000000000000",
"Crewdays": 0,
"GrossPrice": 0,
"HasErrors": true,
"HasNotes": true,
"Hours": 0,
"Mandays": 0,
"NetCost": 0,
"Pages": [
{
"ScaleText": "string",
"ScaleCoords": 0,
"CorrelationKey": "00000000-0000-0000-0000-000000000000",
"BackgroundDrawingID": "00000000-0000-0000-0000-000000000000",
"DrawingDPI": 0,
"DrawingHeightPixels": 0,
"DrawingWidthPixels": 0,
"GrossPrice": 0,
"HasBackgroundImage": true,
"HasErrors": true,
"HasNotes": true,
"Hours": 0,
"Mandays": 0,
"NetCost": 0,
"Conditions": [
{
"CorrelationKey": "00000000-0000-0000-0000-000000000000",
"Description": "string",
"Items": [
{
"UserCodeDescription": "string",
"CostType": "string",
"OrderUnit": "string",
"UnitPrice": 0,
"AdjustedOrderQuantity": 0,
"PriceUnit": "string",
"Description": "string",
"EstimatedQuantity": 0,
"UserCodeCode": "string",
"EstimatedUnit": "string",
"CostPerEstimatedUnit": 0,
"EstimatedUnitPerManday": 0,
"EstimatedUnitPerHour": 0,
"CostPerHour": 0,
"Hours": 0,
"NetCost": 0,
"GrossPrice": 0,
"GrossPrice2": 0,
"IsLabor": true,
"User3": "string",
"User4": "string",
"ItemNumber": 0,
"CorrelationKey": "00000000-0000-0000-0000-000000000000",
"User1Id": "00000000-0000-0000-0000-000000000000",
"User1Code": "string",
"User1Description": "string",
"User2Id": "00000000-0000-0000-0000-000000000000",
"User2Code": "string",
"User2Description": "string",
"Mandays": 0,
"Crewdays": 0,
"EstimatedUnitPerCrewday": 0
}
],
"AltQuantity": 0,
"AltUnit": "string",
"BaseQuantity": 0,
"BaseUnit": "string",
"Crewdays": 0,
"GrossPrice": 0,
"NetCost": 0,
"GroupCode": "string",
"HasErrors": true,
"Hours": 0,
"IndustryId": 0,
"Mandays": 0,
"Manufacturer": "string",
"ConditionNumber": 0,
"QuantityFromConditionCorrelationKey": "00000000-0000-0000-0000-000000000000"
}
],
"P1": "string",
"P2": "string",
"P3": "string",
"PageNumber": 0,
"Pitch": "string",
"Repeat": 0,
"Title": "string",
"Crewdays": 0
}
],
"Repeat": 0,
"S1": "string",
"S2": "string",
"S3": "string",
"SectionNumber": 0,
"Title": "string"
}
],
"Images": [
{
"BidImageId": "00000000-0000-0000-0000-000000000000",
"BidImageRevisionId": "00000000-0000-0000-0000-000000000000",
"Filename": "string",
"Description": "string",
"Width": 0,
"Height": 0,
"DPI": 0
}
],
"BidScenarioId": "00000000-0000-0000-0000-000000000000",
"BidInfo": {
"Address1": "string",
"Address2": "string",
"State": "string",
"City": "string",
"PostalCode": "string",
"J1": "string",
"J2": "string",
"J3": "string",
"J4": "string",
"J5": "string",
"J6": "string",
"J7": "string",
"J8": "string",
"BidNumber": "string",
"BidName": "string",
"BidId": "00000000-0000-0000-0000-000000000000"
}
}

Scenario_Pages​

POST
/scenario/Pages

Scenario_Pages

Authorizations​

apiKeyHeader
Type
API Key (header: Ocp-Apim-Subscription-Key)
or
apiKeyQuery
Type
API Key (query: subscription-key)

Parameters​

Header Parameters

Authorization

access token

Type
string

Query Parameters

dataInput.tenantId

Format - uuid.

Type
string
Format
"uuid"
dataInput.userId

Format - uuid.

Type
string
Format
"uuid"
dataInput.bidScenarioId

Format - uuid.

Type
string
Format
"uuid"

Request Body​

JSON
{
"TenantId": "00000000-0000-0000-0000-000000000000",
"UserId": "00000000-0000-0000-0000-000000000000",
"BidScenarioId": "00000000-0000-0000-0000-000000000000"
}

Responses​

OK

JSON
{
"J1": "string",
"J2": "string",
"J3": "string",
"J4": "string",
"J5": "string",
"J6": "string",
"J7": "string",
"J8": "string",
"ReportId": "00000000-0000-0000-0000-000000000000",
"ReportSchemaType": "string",
"PageInfo": "string",
"BidName": "string",
"Title": "string",
"Crewdays": 0,
"GrossPrice": 0,
"HasErrors": true,
"Hours": 0,
"Mandays": 0,
"NetCost": 0,
"Sections": [
{
"CorrelationKey": "00000000-0000-0000-0000-000000000000",
"Crewdays": 0,
"GrossPrice": 0,
"HasErrors": true,
"HasNotes": true,
"Hours": 0,
"Mandays": 0,
"NetCost": 0,
"Pages": [
{
"ScaleText": "string",
"ScaleCoords": 0,
"CorrelationKey": "00000000-0000-0000-0000-000000000000",
"BackgroundDrawingID": "00000000-0000-0000-0000-000000000000",
"DrawingDPI": 0,
"DrawingHeightPixels": 0,
"DrawingWidthPixels": 0,
"GrossPrice": 0,
"HasBackgroundImage": true,
"HasErrors": true,
"HasNotes": true,
"Hours": 0,
"Mandays": 0,
"NetCost": 0,
"Conditions": [
{
"CorrelationKey": "00000000-0000-0000-0000-000000000000",
"Description": "string",
"Items": [
{
"UserCodeDescription": "string",
"CostType": "string",
"OrderUnit": "string",
"UnitPrice": 0,
"AdjustedOrderQuantity": 0,
"PriceUnit": "string",
"Description": "string",
"EstimatedQuantity": 0,
"UserCodeCode": "string",
"EstimatedUnit": "string",
"CostPerEstimatedUnit": 0,
"EstimatedUnitPerManday": 0,
"EstimatedUnitPerHour": 0,
"CostPerHour": 0,
"Hours": 0,
"NetCost": 0,
"GrossPrice": 0,
"GrossPrice2": 0,
"IsLabor": true,
"User3": "string",
"User4": "string",
"ItemNumber": 0,
"CorrelationKey": "00000000-0000-0000-0000-000000000000",
"User1Id": "00000000-0000-0000-0000-000000000000",
"User1Code": "string",
"User1Description": "string",
"User2Id": "00000000-0000-0000-0000-000000000000",
"User2Code": "string",
"User2Description": "string",
"Mandays": 0,
"Crewdays": 0,
"EstimatedUnitPerCrewday": 0
}
],
"AltQuantity": 0,
"AltUnit": "string",
"BaseQuantity": 0,
"BaseUnit": "string",
"Crewdays": 0,
"GrossPrice": 0,
"NetCost": 0,
"GroupCode": "string",
"HasErrors": true,
"Hours": 0,
"IndustryId": 0,
"Mandays": 0,
"Manufacturer": "string",
"ConditionNumber": 0,
"QuantityFromConditionCorrelationKey": "00000000-0000-0000-0000-000000000000"
}
],
"P1": "string",
"P2": "string",
"P3": "string",
"PageNumber": 0,
"Pitch": "string",
"Repeat": 0,
"Title": "string",
"Crewdays": 0
}
],
"Repeat": 0,
"S1": "string",
"S2": "string",
"S3": "string",
"SectionNumber": 0,
"Title": "string"
}
],
"Images": [
{
"BidImageId": "00000000-0000-0000-0000-000000000000",
"BidImageRevisionId": "00000000-0000-0000-0000-000000000000",
"Filename": "string",
"Description": "string",
"Width": 0,
"Height": 0,
"DPI": 0
}
],
"BidScenarioId": "00000000-0000-0000-0000-000000000000",
"BidInfo": {
"Address1": "string",
"Address2": "string",
"State": "string",
"City": "string",
"PostalCode": "string",
"J1": "string",
"J2": "string",
"J3": "string",
"J4": "string",
"J5": "string",
"J6": "string",
"J7": "string",
"J8": "string",
"BidNumber": "string",
"BidName": "string",
"BidId": "00000000-0000-0000-0000-000000000000"
}
}

Get all items for the specified Scenario.​

POST
/scenario/items

Get all items for the specified Scenario.

Authorizations​

apiKeyHeader
Type
API Key (header: Ocp-Apim-Subscription-Key)
or
apiKeyQuery
Type
API Key (query: subscription-key)

Parameters​

Header Parameters

Authorization

access token

Type
string

Query Parameters

request.bidScenarioId

Format - uuid.

Type
string
Format
"uuid"

Responses​

OK

JSON
{
"Items": [
{
"Description": "string",
"ItemNumber": 0,
"CorrelationKey": "00000000-0000-0000-0000-000000000000",
"AddMinutes": 0,
"ProductionMultiplier": 0,
"EstimatedQuantity": 0,
"ProductionRate": 0,
"TemplatedFields": "string",
"OrderQuantity": 0,
"AddMinutesPercent": 0,
"WastedQuantity": 0,
"OrderFormulaTemplate": "string",
"OrderFormula": "string",
"OrderQuantityAdd": 0,
"AdjustedOrderQuantity": 0,
"RoundOrderQuantity": true,
"OrderUnit": "string",
"PriceFormulaTemplate": "string",
"PriceFormula": "string",
"PriceQuantity": 0,
"PriceUnit": "string",
"C1": "string",
"C1Name": "string",
"C2": "string",
"C2Name": "string",
"C3": "string",
"C3Name": "string",
"C4": "string",
"C4Name": "string",
"C5": "string",
"C5Name": "string",
"C6": "string",
"C6Name": "string",
"UnitPrice": 0,
"PartNumber": "string",
"Errors": "string",
"User4": "string",
"User3": "string",
"User2Code": "string",
"User2Description": "string",
"User1Code": "string",
"User1Description": "string",
"PieceUnit": "string",
"Pieces": 0,
"PieceCQty": "string",
"IsLabor": true,
"AddHours": 0,
"Comment": "string",
"PageDescription": "string",
"PageNumber": 0,
"ConditionDescription": "string",
"ConditionNumber": 0,
"HoursPerManday": 0,
"PricingMethod": "string",
"LaborType": "string",
"Crewdays": 0,
"Mandays": 0,
"Hours": 0,
"Minutes": 0,
"SubdivisionCode": "string",
"SubdivisionName": "string",
"HasErrors": true,
"CrewSize": 0,
"PiecesPerManday": 0,
"CostPerEU": 0,
"RatePerHour": 0,
"DatabaseUnitPrice": 0,
"PieceCQtyTemplate": "string",
"GrossPrice": 0,
"NetCost": 0,
"IsMiscItem": true,
"NetPlusMarkups": 0,
"ExcludeQuantity": true,
"IncludeAlways": true,
"IsOff": true,
"CQtyTemplate": "string",
"CQty": "string",
"QuantityFrom": "string",
"FromCode": "string",
"Quantity": 0,
"EstimatedUnit": "string",
"CostType": "string",
"UserCodeCode": "string",
"UserCodeDescription": "string",
"WastePercent": 0,
"RawOrderQuantity": 0,
"Multiplier": 0,
"SectionDescription": "string",
"SectionNumber": 0,
"EUPerMandays": 0,
"EuPerHours": 0,
"Markups": [
{
"Type": "string",
"Name": "string",
"Amount": 0
}
]
}
],
"ServerName": "string",
"TenantId": "00000000-0000-0000-0000-000000000000",
"UserId": "00000000-0000-0000-0000-000000000000",
"ProcessingTime": 0,
"HasError": true,
"ErrorMessage": "string",
"StackTrace": "string",
"RequestKey": "string"
}
Powered by VitePress OpenAPI

Released under the Proprietary License.

Copyright © 2026 Edge