Replace operator type by ID
put
/productionMonitoring/clientapi/v2/operatorTypes/{type-id}
This operation replaces the specified operator type information with the provided operator type definition. This method supports the request header with name 'X-ORACLE-IOT-ORG', which allows targeting requests to different organizations. The value of this request header should contain the organization identifier.
Request
Supported Media Types
- multipart/form-data
Path Parameters
-
type-id: string
Identifier created by the Oracle IoT Cloud Service for the operator type
Header Parameters
-
X-ORACLE-IOT-ORG: string
This method supports the request header with name 'X-ORACLE-IOT-ORG', which allows targeting requests to different organizations. The value of this request header should contain the organization identifier.
Root Schema : OperatorType_create
Type:
Show Source
object
-
description(optional):
string
The description for the given operator type
-
name(optional):
string
User-defined unique name for the operator type
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : OperatorType_receive
Type:
Show Source
object
-
description:
string
The description for the given operator type
-
extId:
string
The external identifier representing the external operator type imported
-
icon:
object icon
Binary object representing operator type icon.
-
id:
string
Identifier created by the Oracle IoT Cloud Service for the operator type
-
integrationId:
string
The integration identifier that imported the operator type
-
lastModifiedTime:
integer
The time when the operator type definition was last updated as an epoch milliseconds
-
lastModifiedTimeAsString:
integer
The time when the operator type definition was last updated as an ISO-8601 formatted string
-
modifiedBy:
string
The name of the user who last modified the definition of the operator type
-
name:
string
User-defined unique name for the operator type
-
properties:
object properties
Additional Properties Allowed: additionalPropertiesThe operator type's external entity properties as key, value pairs.
-
registeredBy:
string
The name of the user who registered this operator type
-
registrationTime:
integer
The time when the operator type was registered with the app as an epoch milliseconds
-
registrationTimeAsString:
integer
The time when the operator type was registered with the app as an ISO-8601 formatted string
Nested Schema : icon
Type:
object
Binary object representing operator type icon.
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : properties
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
The operator type's external entity properties as key, value pairs.
Show Source
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
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.
404 Response
Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.
406 Response
Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
415 Response
Unsupported Media Type. The request entity has a media type which the server or resource does not support.
Examples
curl -X PUT
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/productionMonitoring/clientapi/v2/operatorTypes/{type-id}
Example of Request Body
The following example shows the content of the request body in JSON format:
{
"description":"The description for the given operator type",
"name":"User-defined unique name for the operator type"
}
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"description":"The description for the given operator type",
"extId":"314352727e00-6bc4",
"icon":{
"links":[
{
"href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
"rel":"canonical"
}
]
},
"id":"bc331ba5f79-6c05",
"integrationId":"46b75fda2d24-6260",
"lastModifiedTime":1469184297746,
"lastModifiedTimeAsString":1469184297746,
"modifiedBy":"The name of the user who last modified the definition of the operator type",
"name":"User-defined unique name for the operator type",
"properties":{
"properties_key1":"properties_value1",
"properties_key2":"properties_value2",
"properties_key3":"properties_value3"
},
"registeredBy":"The name of the user who registered this operator type",
"registrationTime":1469184297746,
"registrationTimeAsString":1469184297746
}
Complete cURL Example
The following example shows a complete cURL command that you can use to perform the described operation:
curl -X PUT
-u <username>:<password>
-H 'Accept: application/json'
-d '{"description":"The description for the given operator type","name":"User-defined unique name for the operator type"}'
https://iotserver/productionMonitoring/clientapi/v2/operatorTypes/168f4dd503f-199e
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.