Jump to

• Request
• Response
• Examples

Retrieve provisioning files for vehicle sensors by vehicle identifiers

post

/fleetMonitoring/clientapi/v2/provisioner/vehicles

This operation returns the provisioning files for vehicle sensors registered in the system by providing the vehicle identifiers.

Request

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=singular

Body ()

Root Schema : VehicleIdentifierProvisioningRequest_create

Type: object

Show Source

• passphrase: string
  Passphrase that would be used to encrypt the provisioning attributes
• registrationNumbers: array registrationNumbers
  Identifier of the entity to get provisioning information.
• transport(optional): string
  Transport used by devices to communicate with the IoT Cloud service. Values are "https"

{
    "type":"object",
    "required":[
        "registrationNumbers",
        "passphrase"
    ],
    "properties":{
        "registrationNumbers":{
            "description":"Identifier of the entity to get provisioning information.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "passphrase":{
            "description":"Passphrase that would be used to encrypt the provisioning attributes",
            "type":"string"
        },
        "transport":{
            "description":"Transport used by devices to communicate with the IoT Cloud service. Values are "https"",
            "type":"string"
        }
    }
}

Nested Schema : registrationNumbers

Type: array

Identifier of the entity to get provisioning information.

Show Source

• Array of: string

{
    "description":"Identifier of the entity to get provisioning information.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/zip

200 Response

Successfully processed.

Body ()

Root Schema : VehicleIdentifierProvisioningRequest_receive

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

410 Response

Gone. The request could not be completed because the resource is intentionally unavailable. This code is only allowed in situations where it is expected that resource is intentionally unavailable. The request can only be repeated if the cause for the unavailability changes

503 Response

Service Unavailable. The request could not be completed because the resource is in busy and is not available. The request can be repeated if at a later time, when it can succeed

Back to Top

Examples

curl -X POST 
   -u <username>:<password> 
   -H 'Content-Type: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/provisioner/vehicles 

Example of Request Body

The following example shows the content of the request body in JSON format:

{
    "registrationNumbers":[
        "registrationNumbers_1",
        "registrationNumbers_2",
        "registrationNumbers_3"
    ],
    "passphrase":"Passphrase that would be used to encrypt the provisioning attributes",
    "transport":"Transport used by devices to communicate with the IoT Cloud service. Values are 'https'"
} 

Complete cURL Example

The following example shows the complete cURL command that can be used to perform the described operation:

curl -X POST 
   -u <username>:<password> 
   -H 'Content-Type: application/json'  
   -d '{"registrationNumbers":["registrationNumbers_1","registrationNumbers_2","registrationNumbers_3"],"passphrase":"Passphrase that would be used to encrypt the provisioning attributes","transport":"Transport used by devices to communicate with the IoT Cloud service. Values are 'https'"}'
   https://iotserver/fleetMonitoring/clientapi/v2/provisioner/vehicles 

Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.

Back to Top