Skip to main content
API docs by Redocly

VCS API - Apigee (1.2.2)

Download OpenAPI specification:Download

License: Internal

VCS API documentation

Authentication & Authorization

You will need to be identified before calling any VCS API endpoints.

In order to be recognized and authorized to access our VCS API, we put in place 2 mechanisms:

  • Authentication mechanism is done with an API key dedicated to you.
    Remember that the API key provided should be shared with care.
    The API key must be inserted in the header of the request in the appropriate field
  • Authorization mechanism is done by a well-known authorization flow for REST Web API: “Client credentials” OAuth2.0 flow.

Inspections

Inspections operation with all operation types

Get inspections data

Get inspections data filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
required
integer <int32> (PageNumberQueryParam) [ 1 .. 1000 ]
Example: pageNumber=2

The page number

pageSize
required
integer <int32> (PageSizeQueryParam) [ 1 .. 1000 ]
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (lastModifiedDateFromParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (lastModifiedDateToParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

managingServiceCenterCode
string (managingServiceCenterCodeParam) <= 255 characters

Managing service center code

vehicleCode
string (vehicleCodeParam) <= 255 characters
Example: vehicleCode=AA-123-BB

Vehicle code param

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "inspections": [
    ]
}