Services

The OLP CLI supports the following functionality for HERE Location Services:

• list all visible services
• show a service
• version list the service versions

service list

Lists all location services that you are allowed to access.

olp service list [command options]

Optional parameters:

• --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the OLP Portal.
• --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
• --json Display a list of services in JSON format.
• --quiet Display service HRNs, each on a new line.

For more information on using credentials and profiles, see Credentials Setup.

Example:

The command below lists all the services to which you have access.

olp service list --json

Output:

{"services": [
    {
        "owner": {
            "creator": "Ru9zEteKdJLTyMf8pDDT",
            "organisation": "olp-here"
        },
        "summary": "The service example for demonstration purposes.",
        "baseUrl": "https://location-service-demo.services.api.platform.here.com",
        "protocol": "REST",
        "hrn": "hrn:here:service::olp-here:location-service-demo-1",
        "created": "2019-08-06T13:35:50.94598Z",
        "name": "Location Service Demo",
        "state": "Running",
        "dataSources": [{
            "owner": "HERE",
            "schema": "HERE example",
            "name": "HERE example",
            "description": "HERE example data"
        }],
        "updated": "2019-08-06T13:35:50.94598Z",
        "version": "1.0.0",
        "tags": [
            "HERE",
            "EXAMPLE"
        ]
    }
]}

service show

Shows the properties of a specified location service.

olp service show <service HRN> [command options]

Required parameters:

• <service HRN> The HRN of the service to show.

Optional parameters:

• --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the OLP Portal.
• --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
• --json Display the service properties in JSON format.
• --quiet Display the service HRN.

For more information on using credentials and profiles, see Credentials Setup.

Example:

The command below displays the properties of the specified service.

olp service show hrn:here:service::olp-here:open-vehicle-routing-0 --json

Output:

{
    "owner": {
        "creator": "QoagGAKgreOKSlypB8M8",
        "organisation": "olp-here"
    },
    "summary": "The Routing - Vehicle service end point calculates routes between two or more locations using various transport modes and provides additional  route-related information. The Routing API is customizable so that the route calculation and additional information can be adapted to both  consumer and enterprise applications.",
    "baseUrl": "https://vehicle.router.hereapi.com/v0",
    "protocol": "REST",
    "hrn": "hrn:here::olp-here:routing-vehicle-0",
    "created": "2019-08-06T12:39:00.441365Z",
    "name": "Routing - Vehicle",
    "state": "Running",
    "dataSources": [{
        "owner": "HERE",
        "name": "Here Map Content"
    }],
    "updated": "2019-08-06T12:39:00.441365Z",
    "version": "1.0.0",
    "tags": [
        "Waypoints",
        "Navigation",
        "Directions",
        "Traffic",
        "Routing",
        "Maneuvers",
        "Open",
        "Vehicle",
        "HERE",
        "ETA",
        "Short route",
        "Route shape",
        "Car",
        "Fast route",
        "OLS",
        "Alternative routes",
        "Route"
    ]
}

service version list

Lists versions of the specified location service.

olp service version list <service HRN> [command options]

Required parameters:

• <service HRN> The HRN of the service to list versions.

Optional parameters:

• --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the OLP Portal.
• --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
• --json Display the service versions list in JSON format.
• --quiet Display the service versions.

For more information on using credentials and profiles, see Credentials Setup.

Example:

The command below displays a list of versions of the specified service.

olp service version list hrn:here:service::olp-here:open-vehicle-routing-0 --json

Output:

{"serviceVersions": [
    {
        "versionDescription": "Update message 4",
        "version": "3.1.3",
        "updated": "2019-10-11T12:32:41.970332Z"
    },
    {
        "versionDescription": "Update message 3",
        "version": "3.1.2",
        "updated": "2019-10-11T12:31:22.436954Z"
    },
    {
        "versionDescription": "Update message 2",
        "version": "3.1.1",
        "updated": "2019-10-04T13:44:21.514794Z"
    }
]}