Create Communication
post
https://server:port/rest/apis/asset/work/communication/
This operation creates the communication log and links it to the work document provided in the request.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
comments: string
Maximum Length:
4000
Information from the customer.Example:Follow up on the meter read.
-
communicationExternald: string
Maximum Length:
254
The external system's unique identifier for the communication log.Example:CN189761809
-
communicationType: string
Allowed Values:
[ "W1CN", "W1EM", "W1PH" ]
Indicates how the communication was received from the customer. * `W1CN` - Counter, * `W1EM` - Email, * `W1PH` - PhoneExample:W1EM
-
firstName: string
Maximum Length:
254
The first name of the contact person.Example:Robert
-
homePhone: string
Maximum Length:
24
The home phone number of the contact person.Example:330-532-9834
-
lastName: string
Maximum Length:
254
The last name of the contact person.Example:Brown
-
mobilePhone: string
Maximum Length:
24
The mobile phone number of the contact person.Example:330-532-9834
-
originatingEntity: object
originatingEntity
-
primaryPhone: string
Maximum Length:
24
The primary phone number of the contact person.Example:330-532-9834
Nested Schema : originatingEntity
Type:
Show Source
object
-
entityId: string
Maximum Length:
254
The system-generated unique identifier for the entity type.Example:20124908366206
-
entityType: string
Allowed Values:
[ "W1WD", "W1WO", "W1WR" ]
Entity types are the work documents linked to the communication log. * `W1WD` - Work Design, * `W1WO` - Work Order, * `W1WR` - Work RequestExample:W1WR
Root Schema : schema
Type:
Show Source
object
-
comments: string
Maximum Length:
4000
Information from the customer.Example:Follow up on the meter read.
-
communicationExternald: string
Maximum Length:
254
The external system's unique identifier for the communication log.Example:CN189761809
-
communicationType: string
Allowed Values:
[ "W1CN", "W1EM", "W1PH" ]
Indicates how the communication was received from the customer. * `W1CN` - Counter, * `W1EM` - Email, * `W1PH` - PhoneExample:W1EM
-
firstName: string
Maximum Length:
254
The first name of the contact person.Example:Robert
-
homePhone: string
Maximum Length:
24
The home phone number of the contact person.Example:330-532-9834
-
lastName: string
Maximum Length:
254
The last name of the contact person.Example:Brown
-
mobilePhone: string
Maximum Length:
24
The mobile phone number of the contact person.Example:330-532-9834
-
originatingEntity: object
originatingEntity
-
primaryPhone: string
Maximum Length:
24
The primary phone number of the contact person.Example:330-532-9834
Nested Schema : originatingEntity
Type:
Show Source
object
-
entityId: string
Maximum Length:
254
The system-generated unique identifier for the entity type.Example:20124908366206
-
entityType: string
Allowed Values:
[ "W1WD", "W1WO", "W1WR" ]
Entity types are the work documents linked to the communication log. * `W1WD` - Work Design, * `W1WO` - Work Order, * `W1WR` - Work RequestExample:W1WR
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : W1CreComm
Type:
Show Source
object
-
_self: string
_self
-
communicationExternald: string
Maximum Length:
254
The external system's unique identifier for the communication log.Example:CN189761809
-
communicationId: string
Maximum Length:
14
The system-generated unique identifier for the communication log.Example:17796561499666
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.