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

apiV1HealthGet

GET /api/v1/health

Get information about the health status of the service.

Description

This endpoint returns the health status of the service.

Parameters

Return Type

HealthReportSummary

Content Type

application/json

Responses

Table 1. HTTP Response Codes
Code	Message	Datatype
200	The summary of all health checks	HealthReportSummary
503	The summary of all health checks	HealthReportSummary

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.

Body Parameter

Name	Description	Required	Default	Pattern
AddPurchaseIntentionMetric	AddPurchaseIntentionMetric	-

Name

Description

Required

Default

Pattern

AddPurchaseIntentionMetric

AddPurchaseIntentionMetric

Return Type

Metric

Content Type

application/json

Responses

Table 2. HTTP Response Codes
Code	Message	Datatype
200	OK	Metric
401	Unauthorized	ProblemDetails
403	Forbidden	ProblemDetails
404	Not Found	ErrorMessage
422	Unprocessable Content	ValidationProblem
500	Internal Server Error	ErrorMessageWithId

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.

Parameters

Query Parameters

Name	Description	Required	Default	Pattern
PageNumber	The page number	-	null
PageSize	The page size	-	null

Name

Description

Required

Default

Pattern

PageNumber

The page number

null

PageSize

The page size

null

Return Type

array[Product]

Return Header

x-pagination PaginationHeader

Content Type

application/json

Responses

Table 3. HTTP Response Codes
Code	Message	Datatype
200	OK	List[Product]
401	Unauthorized	ProblemDetails
403	Forbidden	ProblemDetails
500	Internal Server Error	ErrorMessageWithId
401	Unauthorized	ProblemDetails
403	Forbidden	ProblemDetails
500	Internal Server Error	ErrorMessageWithId

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.

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id	The id for which the product delivery time should be requested	X	null

Name

Description

Required

Default

Pattern

The id for which the product delivery time should be requested

null

Return Type

array[ProductDeliveryTime]

Content Type

application/json

Responses

Table 4. HTTP Response Codes
Code	Message	Datatype
200	OK	List[ProductDeliveryTime]
401	Unauthorized	ProblemDetails
403	Forbidden	ProblemDetails
404	Not Found	ErrorMessage
422	Unprocessable Content	ValidationProblem
500	Internal Server Error	ErrorMessageWithId

apiV1ProductIdGet

GET /api/v1/product/{id}

Get a product by id

Description

This endpoint returns a specific product for a given unique ID.

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Name

Description

Required

Default

Pattern

null

Return Type

Product

Content Type

application/json

Responses

Table 5. HTTP Response Codes
Code	Message	Datatype
200	OK	Product
401	Unauthorized	ProblemDetails
403	Forbidden	ProblemDetails
404	Not Found	ErrorMessage
422	Unprocessable Content	ValidationProblem
500	Internal Server Error	ErrorMessageWithId

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.

Parameters

Query Parameters

Name	Description	Required	Default	Pattern
PageNumber	The page number	-	null
PageSize	The page size	-	null

Name

Description

Required

Default

Pattern

PageNumber

The page number

null

PageSize

The page size

null

Return Type

array[ShortProductInformation]

Return Header

x-pagination PaginationHeader

Content Type

application/json

Responses

Table 6. HTTP Response Codes
Code	Message	Datatype
200	OK	List[ShortProductInformation]
401	Unauthorized	ProblemDetails
403	Forbidden	ProblemDetails
500	Internal Server Error	ErrorMessageWithId

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.

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
QueryByNumber	QueryByNumber	-

Name

Description

Required

Default

Pattern

QueryByNumber

QueryByNumber

Return Type

Product

Content Type

application/json

Responses

Table 7. HTTP Response Codes
Code	Message	Datatype
200	OK	Product
401	Unauthorized	ProblemDetails
403	Forbidden	ProblemDetails
404	Not Found	ErrorMessage
422	Unprocessable Content	ValidationProblem
500	Internal Server Error	ErrorMessageWithId

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.

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id	the resource id	X	null

Name

Description

Required

Default

Pattern

the resource id

null

Return Type

[File]

Return Header

ContentHeader

Content Type

text/plain
application/json
text/json

Responses

Table 8. HTTP Response Codes
Code	Message	Datatype
200	OK	[File]
401	Unauthorized	ProblemDetails
403	Forbidden	ProblemDetails
404	Not Found	ErrorMessage
422	Unprocessable Content	ValidationProblem
500	Internal Server Error	ErrorMessageWithId

Models

AddPurchaseIntentionMetric

The add purchase intention metric

Field Name	Required	Nullable	Type	Description	Format
IamNumber		X	String	The IamNumber
CustomerInformation		X	CustomerInformation

Field Name

Required

Nullable

Type

Description

Format

IamNumber

String

The IamNumber

CustomerInformation

CustomerInformation

BooleanValue

This class describes a boolean value

Field Name	Required	Nullable	Type	Description	Format
Value			Boolean	The value e.g. '5.0'

Field Name

Required

Nullable

Type

Description

Format

Value

Boolean

The value e.g. '5.0'

CustomerInformation

CustomerInformation information

Field Name	Nullable	Type	Description
Identifier	X	String	The identifier. Use an anonymized identifier
Origin	X	String	The origin
Language	X	String	The language

Field Name

Required

Nullable

Type

Description

Format

Identifier

String

The identifier. Use an anonymized identifier

Origin

String

The origin

Language

String

The language

DownloadableFileResource

Resource as url

Field Name	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

Field Name

Required

Nullable

Type

Description

Format

ResourceId

UUID

Culture specific resource id

uuid

MimeType

String

The mime type of the resource

FileName

String

The file name

ErrorMessage

Field Name	Required	Nullable	Type	Description	Format
Status		X	String
Message		X	String

Field Name

Required

Nullable

Type

Description

Format

Status

String

Message

String

ErrorMessageWithId

Field Name	Nullable	Type
Status	X	String
Message	X	String
ErrorId	X	String

Field Name

Required

Nullable

Type

Description

Format

Status

String

Message

String

ErrorId

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

Field Name

Required

Nullable

Type

Description

Format

ResourceType

String

The resource type

LocalizedResources

List of MultiLocaleResource

A list of culture specific resources

HealthCheckEntity

The health ceck entity

Field Name	Nullable	Type	Format
Name	X	String
Status		HealthStatus	Unhealthy, Degraded, Healthy,
Description	X	String
Duration		String	date-span

Field Name

Required

Nullable

Type

Description

Format

Name

String

Status

HealthStatus

Unhealthy, Degraded, Healthy,

Description

String

Duration

String

date-span

HealthReportSummary

The health report summary

Field Name	Nullable	Type	Format
Status		HealthStatus	Unhealthy, Degraded, Healthy,
TotalDuration	X	String	date-span
Results	X	List of HealthCheckEntity

Field Name

Required

Nullable

Type

Description

Format

Status

HealthStatus

Unhealthy, Degraded, Healthy,

TotalDuration

String

date-span

Results

List of HealthCheckEntity

HealthStatus

The health status

Enum Values
Unhealthy
Degraded
Healthy

Enum Values

Unhealthy

Degraded

Healthy

Metric

The product metric

Field Name	Nullable	Type	Description	Format
IamNumber	X	String	The IamNumber
Data	X	MetricTypeBase	Could be one of PurchaseIntentionMetric
CreatedAt		Date	The creation time	date-time
Id	X	String	The product query id

Field Name

Required

Nullable

Type

Description

Format

IamNumber

String

The IamNumber

Data

MetricTypeBase

Could be one of PurchaseIntentionMetric

CreatedAt

Date

The creation time

date-time

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	Nullable	Type	Description
Language	X	String	Language e.g. "US", "DE", US-EN"
FileResource		DownloadableFileResource
Title	X	String	The title of the file

Field Name

Required

Nullable

Type

Description

Format

Language

String

Language e.g. "US", "DE", US-EN"

FileResource

DownloadableFileResource

Title

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

Field Name

Required

Nullable

Type

Description

Format

Language

String

Language e.g. "US", "DE", US-EN"

Text

String

Culture specific text

NumberValue

The number value

Field Name	Required	Nullable	Type	Description	Format
Value			Double	The value e.g. '5.0'	double

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	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'

Field Name

Required

Nullable

Type

Description

Format

Value

Double

The value e.g. '5.0'

double

Unit

String

The unit name e.g. 'centimeter'

Quantity

String

The quantity name e.g. 'Length'

ProblemDetails

Field Name	Nullable	Type	Format
type	X	String
title	X	String
status	X	Integer	int32
detail	X	String
instance	X	String

Field Name

Required

Nullable

Type

Description

Format

type

String

title

String

status

Integer

int32

detail

String

instance

String

Product

The product, this class is used in the web api

Field Name	Nullable	Type	Description
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		DownloadableFileResource
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		SparePartInformation

Field Name

Required

Nullable

Type

Description

Format

String

The id of the product

BnrShortText

List of MultiLocaleText

The bnr short text contains a short text for different cultures

MaterialShortText

List of MultiLocaleText

The material short text could contain a short text for different cultures

IamNumber

String

The IAM-Number

Image

DownloadableFileResource

Properties

List of Property

The properties of the product

Resources

List of FileResource

List of all resources which are available for the product

SparePartInformation

SparePartInformation

ProductDeliveryTime

Field Name	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

Field Name

Required

Nullable

Type

Description

Format

Current

Integer

Current standard delivery time in working days

int32

MaxQuantity

Double

Maximum order quantity (for which delivery time is guaranteed)

double

Fallback

Integer

Fallback delivery time if order quantity > maxQuantity (AFLLT)

int32

MaxLength

Double

Maximum length

double

Region

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	ValueTypeBase	Could be one of BooleanValue, NumberValue, PhysicalValue, [TextsValue]

Field Name

Required

Nullable

Type

Description

Format

Name

String

Property Name

Value

ValueTypeBase

Could be one of BooleanValue, NumberValue, PhysicalValue, [TextsValue]

PurchaseIntentionMetric

Field Name	Required	Nullable	Type	Description	Format
CustomerInformation		X	one of CustomerInformation	The customer

Field Name

Required

Nullable

Type

Description

Format

CustomerInformation

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

Field Name

Required

Nullable

Type

Description

Format

Number

String

The expected number. Could be a Oem- or a Iam number

MachineType

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

Field Name

Required

Nullable

Type

Description

Format

IamNumber

String

The IAM-Number

MaterialShortText

String

The material short text could contain a short text for different cultures

SparePart

The spare part

Field Name	Nullable	Type	Description
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

Field Name

Required

Nullable

Type

Description

Format

IamNumber

String

The IamNumber of the spare part

Pos

String

The position number

Amount

String

The amount of the spare part

BnrShortText

List of MultiLocaleText

The Bnr short text could contain a short text for different cultures

MaterialShortText

List of MultiLocaleText

The material short text could contain a short text for different cultures

SparePartInformation

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			DownloadableFileResource

Field Name

Required

Nullable

Type

Description

Format

SpareParts

List of SparePart

The list of all spare parts

InstallationDrawing

DownloadableFileResource

TextValue

This class describes a physical value

Field Name	Required	Nullable	Type	Description	Format
Value		X	String	The value e.g. '5.0'

Field Name

Required

Nullable

Type

Description

Format

Value

String

The value e.g. '5.0'

ValidationProblem

Field Name	Nullable	Type	Format
Title	X	String
Status		Integer	int32
Errors	X	Map of [array]

Field Name

Required

Nullable

Type

Description

Format

Title

String

Status

Integer

int32

Errors

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'.

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'.

ContentHeader

Key	Type	Description
content-disposition	string	Contains information about the filename.
content-length	long	The current page size, the page size could be changed by the api if the requested page size greater than maximum page size.
content-type	string	The mime type of the content.

Key

Type

Description

content-disposition

string

Contains information about the filename.

content-length

long

The current page size, the page size could be changed by the api if the requested page size greater than maximum page size.

content-type

string

The mime type of the content.