Api Endpoints
Access
-
OAuth AuthorizationUrl: _, TokenUrl: _https://p15.authz.bosch.com/auth/realms/dc5/protocol/openid-connect/token
-
OAuth AuthorizationUrl: https://p15.authz.bosch.com/auth/realms/dc5/protocol/openid-connect/auth, TokenUrl: https://p15.authz.bosch.com/auth/realms/dc5/protocol/openid-connect/token
-
Bearer Authentication
Endpoints
Health
Metric
apiV1MetricPurchaseintentionPost
POST /api/v1/metric/purchaseintention
Add metric information for the purchase intention.
Description
This endpoint can be used to announce a purchase intension to the system.
Product
apiV1ProductGet
GET /api/v1/product
Get all products with pagination.
Description
This endpoint returns a list of products. The list is divided into several queries using pagination. More information about pagination can be found in the header.
Return Type
array[Product]
Return Header
x-pagination PaginationHeader
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
List[Product] |
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
apiV1ProductIdDeliverytimeGet
GET /api/v1/product/{id}/deliverytime
Get the product delivery time information
Description
This endpoint returns the delivery time for a product. This function is currently an experimental feature.
Return Type
array[ProductDeliveryTime]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
List[ProductDeliveryTime] |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Content |
|
500 |
Internal Server Error |
apiV1ProductIdGet
GET /api/v1/product/{id}
Get a product by id
apiV1ProductInformationGet
GET /api/v1/product/information
Get all product information with pagination.
Description
This endpoint returns a list of short product information. The list is divided into several queries using pagination. More information about pagination can be found in the header.
Return Type
array[ShortProductInformation]
Return Header
x-pagination PaginationHeader
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
List[ShortProductInformation] |
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
apiV1ProductQueryPost
POST /api/v1/product/query
Queries a product by a number. The number could be a OemNumber or a IamNumber.
Description
This endpoint allows you to search for a product. An OemNumber or a IamNumber can be used as a search parameter.
Resource
apiV1ResourceDownloadIdGet
GET /api/v1/resource/download/{id}
Get the resource content
Description
This endpoint allows downloading a resource file. The parameter is a resource ID of a product. Meta information about the file is returned in the header.
Models
AddPurchaseIntentionMetric
The add purchase intention metric
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
IamNumber |
X |
String |
The IamNumber |
||
CustomerInformation |
X |
BooleanValue
This class describes a boolean value
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Value |
Boolean |
The value e.g. '5.0' |
CustomerInformation
CustomerInformation information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Identifier |
X |
String |
The identifier. Use an anonymized identifier |
||
Origin |
X |
String |
The origin |
||
Language |
X |
String |
The language |
DownloadableFileResource
Resource as url
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
ResourceId |
UUID |
Culture specific resource id |
uuid |
||
MimeType |
X |
String |
The mime type of the resource |
||
FileName |
X |
String |
The file name |
ErrorMessageWithId
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Status |
X |
String |
|||
Message |
X |
String |
|||
ErrorId |
X |
String |
FileResource
The file resource information. Each file resource could contains culture specific resource files
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
ResourceType |
X |
String |
The resource type |
||
LocalizedResources |
X |
List of MultiLocaleResource |
A list of culture specific resources |
HealthCheckEntity
The health ceck entity
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Name |
X |
String |
|||
Status |
Unhealthy, Degraded, Healthy, |
||||
Description |
X |
String |
|||
Duration |
String |
date-span |
HealthReportSummary
The health report summary
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Status |
Unhealthy, Degraded, Healthy, |
||||
TotalDuration |
X |
String |
date-span |
||
Results |
X |
List of HealthCheckEntity |
Metric
The product metric
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
IamNumber |
X |
String |
The IamNumber |
||
Data |
X |
Could be one of PurchaseIntentionMetric |
|||
CreatedAt |
Date |
The creation time |
date-time |
||
Id |
X |
String |
The product query id |
MetricTypeBase
This class describes a base metric object. This object is a abstract class and should not be used, this class is used for derivations. Derived values could be one of PurchaseIntentionMetric
MultiLocaleResource
The multi locale resource
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Language |
X |
String |
Language e.g. "US", "DE", US-EN" |
||
FileResource |
|||||
Title |
X |
String |
The title of the file |
MultiLocaleText
The multi locale text
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Language |
X |
String |
Language e.g. "US", "DE", US-EN" |
||
Text |
X |
String |
Culture specific text |
MultiLocaleTextArray
The multi locale text array
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Language |
X |
String |
Language e.g. "US", "DE", US-EN" |
||
Texts |
X |
List of String |
Culture specific texts |
NumberValue
The number value
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Value |
Double |
The value e.g. '5.0' |
double |
PhysicalValue
This class describes a physical value
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Value |
Double |
The value e.g. '5.0' |
double |
||
Unit |
X |
String |
The unit name e.g. 'centimeter' |
||
Quantity |
X |
String |
The quantity name e.g. 'Length' |
ProblemDetails
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
type |
X |
String |
|||
title |
X |
String |
|||
status |
X |
Integer |
int32 |
||
detail |
X |
String |
|||
instance |
X |
String |
Product
The product, this class is used in the web api
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Id |
X |
String |
The id of the product |
||
BnrShortText |
X |
List of MultiLocaleText |
The bnr short text contains a short text for different cultures |
||
MaterialShortText |
X |
List of MultiLocaleText |
The material short text could contain a short text for different cultures |
||
IamNumber |
X |
String |
The IAM-Number |
||
Image |
|||||
Properties |
X |
List of Property |
The properties of the product |
||
Resources |
X |
List of FileResource |
List of all resources which are available for the product |
||
SparePartInformation |
|||||
ShortDescription |
X |
List of MultiLocaleText |
The short description contains a short information about the product for different cultures |
||
Description |
X |
List of MultiLocaleText |
The description contains a longer information about the product for different cultures |
||
Features |
X |
List of MultiLocaleTextArray |
The features contains a information about the features product for different cultures |
ProductDeliveryTime
ProductDeliveryTime
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Current |
X |
Integer |
Current standard delivery time in working days |
int32 |
|
MaxQuantity |
X |
Double |
Maximum order quantity (for which delivery time is guaranteed) |
double |
|
Fallback |
X |
Integer |
Fallback delivery time if order quantity > maxQuantity (AFLLT) |
int32 |
|
MaxLength |
X |
Double |
Maximum length |
double |
|
Region |
X |
String |
Region of plant |
Property
This class presents a property. A property could have different value types e.g. NumberValue, TextValue
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Name |
X |
String |
Property Name |
||
Value |
X |
Could be one of BooleanValue, NumberValue, PhysicalValue, [TextsValue] |
PurchaseIntentionMetric
PurchaseIntentionMetric
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
CustomerInformation |
X |
one of CustomerInformation |
The customer |
QueryByNumber
The query by number class
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Number |
X |
String |
The expected number. Could be a Oem- or a Iam number |
||
MachineType |
X |
String |
The Machine type |
ShortProductInformation
Short product information
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
IamNumber |
X |
String |
The IAM-Number |
||
MaterialShortText |
X |
String |
The material short text could contain a short text for different cultures |
SparePart
The spare part
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
IamNumber |
X |
String |
The IamNumber of the spare part |
||
Pos |
X |
String |
The position number |
||
Amount |
X |
String |
The amount of the spare part |
||
BnrShortText |
X |
List of MultiLocaleText |
The Bnr short text could contain a short text for different cultures |
||
MaterialShortText |
X |
List of MultiLocaleText |
The material short text could contain a short text for different cultures |
||
SparePartInformation |
SparePartInformation
The spare part group
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
SpareParts |
X |
List of SparePart |
The list of all spare parts |
||
InstallationDrawing |
TextValue
This class describes a physical value
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Value |
X |
String |
The value e.g. '5.0' |
ValidationProblem
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
Title |
X |
String |
|||
Status |
Integer |
int32 |
|||
Errors |
X |
Map of [array] |
ValueTypeBase
This class describes a base value object. This object is a abstract class and should not be used, this class is used for derivations. Derived values could be one of NumberValue, TextValue, PhysicalValue, BooleanValue
PaginationHeader
| Key | Type | Description |
|---|---|---|
TotalCount |
long |
The total count of entries. |
PageSize |
long |
The current page size, the page size could be changed by the api if the requested page size greater than maximum page size. |
CurrentPage |
long |
The current page info. |
TotalPages |
long |
The total pages count with the given page size. |
HasNext |
bool |
Is 'true' if there are next pages otherwise 'false'. |
HasPrevious |
bool |
Is 'true' if there are prevoius pages otherwise 'false'. |