POST api/Lookup/GetAvailableCostSetDefinitions
Get available cost set definitions for an activity. Definitions for regular costs will be on a guid format, but definitions for requsitions will have the format RequsitionNumber:RequisitionLine which can be added only once if not already added, and only with quantity set to the same value as defaultQuantity.
Remarks
Available for sub contractor users, Onitio users and partner users with security role PartnerIntegratorWithCostLine
Request Information
URI Parameters
None.
Body Parameters
specify activity
ActivityIdArgumentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CombinedActivityId |
Get or set combined activity id |
string |
None. |
| FormName |
Gets or sets the optional FormName. The FormName is used to limit the number of fields returned from GetActivity. |
string |
None. |
| TicketId |
Gets or sets the ticket id |
string |
None. |
| Culture |
Gets or sets culture, if not specified we will use culture set on user. |
string |
None. |
Request Formats
application/json, text/json
{
"CombinedActivityId": "sample string 1",
"FormName": "sample string 2",
"TicketId": "sample string 3",
"Culture": "sample string 4"
}
application/xml, text/xml
<ActivityIdArgumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">
<Culture>sample string 4</Culture>
<TicketId>sample string 3</TicketId>
<CombinedActivityId>sample string 1</CombinedActivityId>
<FormName>sample string 2</FormName>
</ActivityIdArgumentModel>
application/x-www-form-urlencoded
Response Information
Resource Description
a list of available cost set definitions for activity
CostDefinitionsReturnModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CostSetDefinitionModels |
Gets or sets list of Cost Set definitions |
Collection of CostSetDefinitionModel |
None. |
| CombinedPerformanceId |
Gets or sets the performance id. If performance monitoring is not turned on this property will not be present or set to null |
string |
Json null value handling: Ignore |
Response Formats
application/json, text/json
{
"CostSetDefinitionModels": [
{
"CostSetDefinitionId": "sample string 1",
"CostSetDefinitionName": "sample string 2",
"ServiceCode": "sample string 3",
"InvoiceCustomerNumber1": 1,
"InvoiceCustomerNumber2": 1,
"CostLineDefinitions": [
{
"CostLineDefinitionId": "sample string 1",
"CostLineDefinitionName": "sample string 2",
"CostLineCode": "sample string 3",
"CostLineType": 0,
"DefaultQuantity": 4.0,
"MinValue": 1.0,
"MaxValue": 1.0,
"IsDescriptionRequired": true,
"UsageCount": 6,
"IsOnlyAddableOnce": true,
"Fields": [
{
"FieldName": "sample string 1",
"FieldType": 0,
"FieldValue": {},
"DisplayValue": "sample string 3",
"DisplayOrder": 4,
"AdditionalValue": "sample string 5",
"IsAdditionalValueSupported": true,
"FieldLabel": "sample string 7",
"FieldInfo": "sample string 8",
"FieldLookupProvider": {
"FieldLookupProviderType": "sample string 1",
"FieldLookupProviderId": "sample string 2",
"IsRequired": true,
"UpdateMethod": 0
},
"IsEnabled": true,
"IsEnabledExpression": {
"ExpressionType": "sample string 1"
},
"IsRequired": true,
"IsRequiredExpression": {
"ExpressionType": "sample string 1"
},
"IsVisible": true,
"IsVisibleExpression": {
"ExpressionType": "sample string 1"
}
},
{
"FieldName": "sample string 1",
"FieldType": 0,
"FieldValue": {},
"DisplayValue": "sample string 3",
"DisplayOrder": 4,
"AdditionalValue": "sample string 5",
"IsAdditionalValueSupported": true,
"FieldLabel": "sample string 7",
"FieldInfo": "sample string 8",
"FieldLookupProvider": {
"FieldLookupProviderType": "sample string 1",
"FieldLookupProviderId": "sample string 2",
"IsRequired": true,
"UpdateMethod": 0
},
"IsEnabled": true,
"IsEnabledExpression": {
"ExpressionType": "sample string 1"
},
"IsRequired": true,
"IsRequiredExpression": {
"ExpressionType": "sample string 1"
},
"IsVisible": true,
"IsVisibleExpression": {
"ExpressionType": "sample string 1"
}
}
]
},
{
"CostLineDefinitionId": "sample string 1",
"CostLineDefinitionName": "sample string 2",
"CostLineCode": "sample string 3",
"CostLineType": 0,
"DefaultQuantity": 4.0,
"MinValue": 1.0,
"MaxValue": 1.0,
"IsDescriptionRequired": true,
"UsageCount": 6,
"IsOnlyAddableOnce": true,
"Fields": [
{
"FieldName": "sample string 1",
"FieldType": 0,
"FieldValue": {},
"DisplayValue": "sample string 3",
"DisplayOrder": 4,
"AdditionalValue": "sample string 5",
"IsAdditionalValueSupported": true,
"FieldLabel": "sample string 7",
"FieldInfo": "sample string 8",
"FieldLookupProvider": {
"FieldLookupProviderType": "sample string 1",
"FieldLookupProviderId": "sample string 2",
"IsRequired": true,
"UpdateMethod": 0
},
"IsEnabled": true,
"IsEnabledExpression": {
"ExpressionType": "sample string 1"
},
"IsRequired": true,
"IsRequiredExpression": {
"ExpressionType": "sample string 1"
},
"IsVisible": true,
"IsVisibleExpression": {
"ExpressionType": "sample string 1"
}
},
{
"FieldName": "sample string 1",
"FieldType": 0,
"FieldValue": {},
"DisplayValue": "sample string 3",
"DisplayOrder": 4,
"AdditionalValue": "sample string 5",
"IsAdditionalValueSupported": true,
"FieldLabel": "sample string 7",
"FieldInfo": "sample string 8",
"FieldLookupProvider": {
"FieldLookupProviderType": "sample string 1",
"FieldLookupProviderId": "sample string 2",
"IsRequired": true,
"UpdateMethod": 0
},
"IsEnabled": true,
"IsEnabledExpression": {
"ExpressionType": "sample string 1"
},
"IsRequired": true,
"IsRequiredExpression": {
"ExpressionType": "sample string 1"
},
"IsVisible": true,
"IsVisibleExpression": {
"ExpressionType": "sample string 1"
}
}
]
}
],
"IsHidden": true
},
{
"CostSetDefinitionId": "sample string 1",
"CostSetDefinitionName": "sample string 2",
"ServiceCode": "sample string 3",
"InvoiceCustomerNumber1": 1,
"InvoiceCustomerNumber2": 1,
"CostLineDefinitions": [
{
"CostLineDefinitionId": "sample string 1",
"CostLineDefinitionName": "sample string 2",
"CostLineCode": "sample string 3",
"CostLineType": 0,
"DefaultQuantity": 4.0,
"MinValue": 1.0,
"MaxValue": 1.0,
"IsDescriptionRequired": true,
"UsageCount": 6,
"IsOnlyAddableOnce": true,
"Fields": [
{
"FieldName": "sample string 1",
"FieldType": 0,
"FieldValue": {},
"DisplayValue": "sample string 3",
"DisplayOrder": 4,
"AdditionalValue": "sample string 5",
"IsAdditionalValueSupported": true,
"FieldLabel": "sample string 7",
"FieldInfo": "sample string 8",
"FieldLookupProvider": {
"FieldLookupProviderType": "sample string 1",
"FieldLookupProviderId": "sample string 2",
"IsRequired": true,
"UpdateMethod": 0
},
"IsEnabled": true,
"IsEnabledExpression": {
"ExpressionType": "sample string 1"
},
"IsRequired": true,
"IsRequiredExpression": {
"ExpressionType": "sample string 1"
},
"IsVisible": true,
"IsVisibleExpression": {
"ExpressionType": "sample string 1"
}
},
{
"FieldName": "sample string 1",
"FieldType": 0,
"FieldValue": {},
"DisplayValue": "sample string 3",
"DisplayOrder": 4,
"AdditionalValue": "sample string 5",
"IsAdditionalValueSupported": true,
"FieldLabel": "sample string 7",
"FieldInfo": "sample string 8",
"FieldLookupProvider": {
"FieldLookupProviderType": "sample string 1",
"FieldLookupProviderId": "sample string 2",
"IsRequired": true,
"UpdateMethod": 0
},
"IsEnabled": true,
"IsEnabledExpression": {
"ExpressionType": "sample string 1"
},
"IsRequired": true,
"IsRequiredExpression": {
"ExpressionType": "sample string 1"
},
"IsVisible": true,
"IsVisibleExpression": {
"ExpressionType": "sample string 1"
}
}
]
},
{
"CostLineDefinitionId": "sample string 1",
"CostLineDefinitionName": "sample string 2",
"CostLineCode": "sample string 3",
"CostLineType": 0,
"DefaultQuantity": 4.0,
"MinValue": 1.0,
"MaxValue": 1.0,
"IsDescriptionRequired": true,
"UsageCount": 6,
"IsOnlyAddableOnce": true,
"Fields": [
{
"FieldName": "sample string 1",
"FieldType": 0,
"FieldValue": {},
"DisplayValue": "sample string 3",
"DisplayOrder": 4,
"AdditionalValue": "sample string 5",
"IsAdditionalValueSupported": true,
"FieldLabel": "sample string 7",
"FieldInfo": "sample string 8",
"FieldLookupProvider": {
"FieldLookupProviderType": "sample string 1",
"FieldLookupProviderId": "sample string 2",
"IsRequired": true,
"UpdateMethod": 0
},
"IsEnabled": true,
"IsEnabledExpression": {
"ExpressionType": "sample string 1"
},
"IsRequired": true,
"IsRequiredExpression": {
"ExpressionType": "sample string 1"
},
"IsVisible": true,
"IsVisibleExpression": {
"ExpressionType": "sample string 1"
}
},
{
"FieldName": "sample string 1",
"FieldType": 0,
"FieldValue": {},
"DisplayValue": "sample string 3",
"DisplayOrder": 4,
"AdditionalValue": "sample string 5",
"IsAdditionalValueSupported": true,
"FieldLabel": "sample string 7",
"FieldInfo": "sample string 8",
"FieldLookupProvider": {
"FieldLookupProviderType": "sample string 1",
"FieldLookupProviderId": "sample string 2",
"IsRequired": true,
"UpdateMethod": 0
},
"IsEnabled": true,
"IsEnabledExpression": {
"ExpressionType": "sample string 1"
},
"IsRequired": true,
"IsRequiredExpression": {
"ExpressionType": "sample string 1"
},
"IsVisible": true,
"IsVisibleExpression": {
"ExpressionType": "sample string 1"
}
}
]
}
],
"IsHidden": true
}
],
"CombinedPerformanceId": "sample string 1"
}
application/xml, text/xml
<CostDefinitionsReturnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">
<CombinedPerformanceId>sample string 1</CombinedPerformanceId>
<CostSetDefinitionModels>
<CostSetDefinitionModel>
<CostLineDefinitions>
<CostLineDefinitionModel>
<CostLineCode>sample string 3</CostLineCode>
<CostLineDefinitionId>sample string 1</CostLineDefinitionId>
<CostLineDefinitionName>sample string 2</CostLineDefinitionName>
<CostLineType>Bool</CostLineType>
<DefaultQuantity>4</DefaultQuantity>
<Fields>
<FieldModel>
<AdditionalValue>sample string 5</AdditionalValue>
<DisplayOrder>4</DisplayOrder>
<DisplayValue>sample string 3</DisplayValue>
<FieldInfo>sample string 8</FieldInfo>
<FieldLabel>sample string 7</FieldLabel>
<FieldLookupProvider>
<FieldLookupProviderId>sample string 2</FieldLookupProviderId>
<FieldLookupProviderType>sample string 1</FieldLookupProviderType>
<IsRequired>true</IsRequired>
<UpdateMethod>Set</UpdateMethod>
</FieldLookupProvider>
<FieldName>sample string 1</FieldName>
<FieldType>Bool</FieldType>
<FieldValue />
<IsAdditionalValueSupported>true</IsAdditionalValueSupported>
<IsEnabled>true</IsEnabled>
<IsEnabledExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsEnabledExpression>
<IsRequired>true</IsRequired>
<IsRequiredExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsRequiredExpression>
<IsVisible>true</IsVisible>
<IsVisibleExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsVisibleExpression>
</FieldModel>
<FieldModel>
<AdditionalValue>sample string 5</AdditionalValue>
<DisplayOrder>4</DisplayOrder>
<DisplayValue>sample string 3</DisplayValue>
<FieldInfo>sample string 8</FieldInfo>
<FieldLabel>sample string 7</FieldLabel>
<FieldLookupProvider>
<FieldLookupProviderId>sample string 2</FieldLookupProviderId>
<FieldLookupProviderType>sample string 1</FieldLookupProviderType>
<IsRequired>true</IsRequired>
<UpdateMethod>Set</UpdateMethod>
</FieldLookupProvider>
<FieldName>sample string 1</FieldName>
<FieldType>Bool</FieldType>
<FieldValue />
<IsAdditionalValueSupported>true</IsAdditionalValueSupported>
<IsEnabled>true</IsEnabled>
<IsEnabledExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsEnabledExpression>
<IsRequired>true</IsRequired>
<IsRequiredExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsRequiredExpression>
<IsVisible>true</IsVisible>
<IsVisibleExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsVisibleExpression>
</FieldModel>
</Fields>
<IsDescriptionRequired>true</IsDescriptionRequired>
<IsOnlyAddableOnce>true</IsOnlyAddableOnce>
<MaxValue>1</MaxValue>
<MinValue>1</MinValue>
<UsageCount>6</UsageCount>
</CostLineDefinitionModel>
<CostLineDefinitionModel>
<CostLineCode>sample string 3</CostLineCode>
<CostLineDefinitionId>sample string 1</CostLineDefinitionId>
<CostLineDefinitionName>sample string 2</CostLineDefinitionName>
<CostLineType>Bool</CostLineType>
<DefaultQuantity>4</DefaultQuantity>
<Fields>
<FieldModel>
<AdditionalValue>sample string 5</AdditionalValue>
<DisplayOrder>4</DisplayOrder>
<DisplayValue>sample string 3</DisplayValue>
<FieldInfo>sample string 8</FieldInfo>
<FieldLabel>sample string 7</FieldLabel>
<FieldLookupProvider>
<FieldLookupProviderId>sample string 2</FieldLookupProviderId>
<FieldLookupProviderType>sample string 1</FieldLookupProviderType>
<IsRequired>true</IsRequired>
<UpdateMethod>Set</UpdateMethod>
</FieldLookupProvider>
<FieldName>sample string 1</FieldName>
<FieldType>Bool</FieldType>
<FieldValue />
<IsAdditionalValueSupported>true</IsAdditionalValueSupported>
<IsEnabled>true</IsEnabled>
<IsEnabledExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsEnabledExpression>
<IsRequired>true</IsRequired>
<IsRequiredExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsRequiredExpression>
<IsVisible>true</IsVisible>
<IsVisibleExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsVisibleExpression>
</FieldModel>
<FieldModel>
<AdditionalValue>sample string 5</AdditionalValue>
<DisplayOrder>4</DisplayOrder>
<DisplayValue>sample string 3</DisplayValue>
<FieldInfo>sample string 8</FieldInfo>
<FieldLabel>sample string 7</FieldLabel>
<FieldLookupProvider>
<FieldLookupProviderId>sample string 2</FieldLookupProviderId>
<FieldLookupProviderType>sample string 1</FieldLookupProviderType>
<IsRequired>true</IsRequired>
<UpdateMethod>Set</UpdateMethod>
</FieldLookupProvider>
<FieldName>sample string 1</FieldName>
<FieldType>Bool</FieldType>
<FieldValue />
<IsAdditionalValueSupported>true</IsAdditionalValueSupported>
<IsEnabled>true</IsEnabled>
<IsEnabledExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsEnabledExpression>
<IsRequired>true</IsRequired>
<IsRequiredExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsRequiredExpression>
<IsVisible>true</IsVisible>
<IsVisibleExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsVisibleExpression>
</FieldModel>
</Fields>
<IsDescriptionRequired>true</IsDescriptionRequired>
<IsOnlyAddableOnce>true</IsOnlyAddableOnce>
<MaxValue>1</MaxValue>
<MinValue>1</MinValue>
<UsageCount>6</UsageCount>
</CostLineDefinitionModel>
</CostLineDefinitions>
<CostSetDefinitionId>sample string 1</CostSetDefinitionId>
<CostSetDefinitionName>sample string 2</CostSetDefinitionName>
<InvoiceCustomerNumber1>1</InvoiceCustomerNumber1>
<InvoiceCustomerNumber2>1</InvoiceCustomerNumber2>
<IsHidden>true</IsHidden>
<ServiceCode>sample string 3</ServiceCode>
</CostSetDefinitionModel>
<CostSetDefinitionModel>
<CostLineDefinitions>
<CostLineDefinitionModel>
<CostLineCode>sample string 3</CostLineCode>
<CostLineDefinitionId>sample string 1</CostLineDefinitionId>
<CostLineDefinitionName>sample string 2</CostLineDefinitionName>
<CostLineType>Bool</CostLineType>
<DefaultQuantity>4</DefaultQuantity>
<Fields>
<FieldModel>
<AdditionalValue>sample string 5</AdditionalValue>
<DisplayOrder>4</DisplayOrder>
<DisplayValue>sample string 3</DisplayValue>
<FieldInfo>sample string 8</FieldInfo>
<FieldLabel>sample string 7</FieldLabel>
<FieldLookupProvider>
<FieldLookupProviderId>sample string 2</FieldLookupProviderId>
<FieldLookupProviderType>sample string 1</FieldLookupProviderType>
<IsRequired>true</IsRequired>
<UpdateMethod>Set</UpdateMethod>
</FieldLookupProvider>
<FieldName>sample string 1</FieldName>
<FieldType>Bool</FieldType>
<FieldValue />
<IsAdditionalValueSupported>true</IsAdditionalValueSupported>
<IsEnabled>true</IsEnabled>
<IsEnabledExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsEnabledExpression>
<IsRequired>true</IsRequired>
<IsRequiredExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsRequiredExpression>
<IsVisible>true</IsVisible>
<IsVisibleExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsVisibleExpression>
</FieldModel>
<FieldModel>
<AdditionalValue>sample string 5</AdditionalValue>
<DisplayOrder>4</DisplayOrder>
<DisplayValue>sample string 3</DisplayValue>
<FieldInfo>sample string 8</FieldInfo>
<FieldLabel>sample string 7</FieldLabel>
<FieldLookupProvider>
<FieldLookupProviderId>sample string 2</FieldLookupProviderId>
<FieldLookupProviderType>sample string 1</FieldLookupProviderType>
<IsRequired>true</IsRequired>
<UpdateMethod>Set</UpdateMethod>
</FieldLookupProvider>
<FieldName>sample string 1</FieldName>
<FieldType>Bool</FieldType>
<FieldValue />
<IsAdditionalValueSupported>true</IsAdditionalValueSupported>
<IsEnabled>true</IsEnabled>
<IsEnabledExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsEnabledExpression>
<IsRequired>true</IsRequired>
<IsRequiredExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsRequiredExpression>
<IsVisible>true</IsVisible>
<IsVisibleExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsVisibleExpression>
</FieldModel>
</Fields>
<IsDescriptionRequired>true</IsDescriptionRequired>
<IsOnlyAddableOnce>true</IsOnlyAddableOnce>
<MaxValue>1</MaxValue>
<MinValue>1</MinValue>
<UsageCount>6</UsageCount>
</CostLineDefinitionModel>
<CostLineDefinitionModel>
<CostLineCode>sample string 3</CostLineCode>
<CostLineDefinitionId>sample string 1</CostLineDefinitionId>
<CostLineDefinitionName>sample string 2</CostLineDefinitionName>
<CostLineType>Bool</CostLineType>
<DefaultQuantity>4</DefaultQuantity>
<Fields>
<FieldModel>
<AdditionalValue>sample string 5</AdditionalValue>
<DisplayOrder>4</DisplayOrder>
<DisplayValue>sample string 3</DisplayValue>
<FieldInfo>sample string 8</FieldInfo>
<FieldLabel>sample string 7</FieldLabel>
<FieldLookupProvider>
<FieldLookupProviderId>sample string 2</FieldLookupProviderId>
<FieldLookupProviderType>sample string 1</FieldLookupProviderType>
<IsRequired>true</IsRequired>
<UpdateMethod>Set</UpdateMethod>
</FieldLookupProvider>
<FieldName>sample string 1</FieldName>
<FieldType>Bool</FieldType>
<FieldValue />
<IsAdditionalValueSupported>true</IsAdditionalValueSupported>
<IsEnabled>true</IsEnabled>
<IsEnabledExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsEnabledExpression>
<IsRequired>true</IsRequired>
<IsRequiredExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsRequiredExpression>
<IsVisible>true</IsVisible>
<IsVisibleExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsVisibleExpression>
</FieldModel>
<FieldModel>
<AdditionalValue>sample string 5</AdditionalValue>
<DisplayOrder>4</DisplayOrder>
<DisplayValue>sample string 3</DisplayValue>
<FieldInfo>sample string 8</FieldInfo>
<FieldLabel>sample string 7</FieldLabel>
<FieldLookupProvider>
<FieldLookupProviderId>sample string 2</FieldLookupProviderId>
<FieldLookupProviderType>sample string 1</FieldLookupProviderType>
<IsRequired>true</IsRequired>
<UpdateMethod>Set</UpdateMethod>
</FieldLookupProvider>
<FieldName>sample string 1</FieldName>
<FieldType>Bool</FieldType>
<FieldValue />
<IsAdditionalValueSupported>true</IsAdditionalValueSupported>
<IsEnabled>true</IsEnabled>
<IsEnabledExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsEnabledExpression>
<IsRequired>true</IsRequired>
<IsRequiredExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsRequiredExpression>
<IsVisible>true</IsVisible>
<IsVisibleExpression>
<ExpressionType>sample string 1</ExpressionType>
</IsVisibleExpression>
</FieldModel>
</Fields>
<IsDescriptionRequired>true</IsDescriptionRequired>
<IsOnlyAddableOnce>true</IsOnlyAddableOnce>
<MaxValue>1</MaxValue>
<MinValue>1</MinValue>
<UsageCount>6</UsageCount>
</CostLineDefinitionModel>
</CostLineDefinitions>
<CostSetDefinitionId>sample string 1</CostSetDefinitionId>
<CostSetDefinitionName>sample string 2</CostSetDefinitionName>
<InvoiceCustomerNumber1>1</InvoiceCustomerNumber1>
<InvoiceCustomerNumber2>1</InvoiceCustomerNumber2>
<IsHidden>true</IsHidden>
<ServiceCode>sample string 3</ServiceCode>
</CostSetDefinitionModel>
</CostSetDefinitionModels>
</CostDefinitionsReturnModel>