Ingest OEM factory menu data

OEM-agnostic factory menu ingest endpoint. Accepts a payload containing an OEM brand and a list of menus (with nested line items). Processing is async; returns 202 Accepted immediately.

application/json

Request Body required

the ingest request (oemBrand + menus)

oemBrand string
menus object[]
Array [
menuName string
description string
serviceType string
operationType string
Possible values: [OPCODE, SERVICEMENU, SERVICEMOTORSMAINTENANCEMENU, SERVICEMOTORSLINEITEM, SERVICEMOTORSINDICATOR]
mileage int64
motorsOperationName string
source string
metadata object
property name* object
oemOpcode object
oemOpcode string
oemOpcodeDesc string
oemVehicleIdentifier object
oemVariantId string
oemVariantCode string
serviceIntervals object
mileageKms int64
period string
]

Responses

• 200
• 400
• 401
• 403
• 500

---

202 Accepted with a FactoryMenuIngestResponse

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string
accepted boolean
message string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string",
  "accepted": true,
  "message": "string"
}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Forbidden

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Loading...