Oracle Utilities REST API for Work and Asset

Get Service Call Entities

get

https://server:port/rest/apis/asset/work/serviceCalls/{entityType}/{entityId}

This operation retrieves other work documents, e.g. work request, work design, work order and work activity, that are initiated from the service call. All communication logs related to the work documents are also returned.

Request

Path Parameters

entityId(required): string
entityType(required): string

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : W1RetRelObj

Type: object

Show Source

communicationlogs: array communicationlogs
entityId: string

Maximum Length: 254

The system-generated unique identifier for the entity type.

Example: 24797648086753
entityType: string

Allowed Values: [ "W1WA", "W1WD", "W1WO", "W1WR" ]

This entity type can either be the service call or another work document created from the service call. * `W1WA` - Work Activity, * `W1WD` - Work Design, * `W1WO` - Work Order, * `W1WR` - Work Request

Example: W1WR
info: string

Maximum Length: 1000

Contains relevant information about the service call or another work document created from the service call.

Example: 20220000001209, New Electric Service, Created By: External System, Processed
relatedDocuments: array relatedDocuments

{
    "type":"object",
    "properties":{
        "entityType":{
            "type":"string",
            "enum":[
                "W1WA",
                "W1WD",
                "W1WO",
                "W1WR"
            ],
            "description":"This entity type can either be the service call or another work document created from the service call.\n* `W1WA` - Work Activity,\n* `W1WD` - Work Design,\n* `W1WO` - Work Order,\n* `W1WR` - Work Request",
            "example":"W1WR"
        },
        "entityId":{
            "type":"string",
            "maxLength":254,
            "description":"The system-generated unique identifier for the entity type.",
            "example":"24797648086753"
        },
        "info":{
            "type":"string",
            "maxLength":1000,
            "description":"Contains relevant information about the service call or another work document created from the service call.",
            "example":"20220000001209, New Electric Service, Created By: External System, Processed"
        },
        "communicationlogs":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "communication":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "communicationId":{
                                "type":"string",
                                "maxLength":14,
                                "description":"The system-generated unique identifier for the communication log.",
                                "example":"17796561499666"
                            }
                        }
                    },
                    "info":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Contains relevant information about the communication log.",
                        "example":"06-03-2022 05:20PM, Email, Brown, Robert, Primary Phone: 330-532-9834"
                    }
                }
            }
        },
        "relatedDocuments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "entityType":{
                        "type":"string",
                        "enum":[
                            "W1WA",
                            "W1WD",
                            "W1WO",
                            "W1WR"
                        ],
                        "description":"Work documents created from the service call.\n* `W1WA` - Work Activity,\n* `W1WD` - Work Design,\n* `W1WO` - Work Order,\n* `W1WR` - Work Request",
                        "example":"W1WO"
                    },
                    "info":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Contains relevant information about the work document.",
                        "example":"Work Order: 20220000000213, Approved, Meter Read, 1 Activity"
                    },
                    "entity":{
                        "type":"object",
                        "properties":{
                            "entityId":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The system-generated unique identifier for the entity type.",
                                "example":"24797648086753"
                            },
                            "_link":{
                                "type":"string",
                                "maxLength":256,
                                "description":"Anchor Link"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"W1RetRelObj"
    }
}

Nested Schema : communicationlogs

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "communication":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "communicationId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"The system-generated unique identifier for the communication log.",
                        "example":"17796561499666"
                    }
                }
            },
            "info":{
                "type":"string",
                "maxLength":1000,
                "description":"Contains relevant information about the communication log.",
                "example":"06-03-2022 05:20PM, Email, Brown, Robert, Primary Phone: 330-532-9834"
            }
        }
    }
}

Nested Schema : relatedDocuments

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "entityType":{
                "type":"string",
                "enum":[
                    "W1WA",
                    "W1WD",
                    "W1WO",
                    "W1WR"
                ],
                "description":"Work documents created from the service call.\n* `W1WA` - Work Activity,\n* `W1WD` - Work Design,\n* `W1WO` - Work Order,\n* `W1WR` - Work Request",
                "example":"W1WO"
            },
            "info":{
                "type":"string",
                "maxLength":1000,
                "description":"Contains relevant information about the work document.",
                "example":"Work Order: 20220000000213, Approved, Meter Read, 1 Activity"
            },
            "entity":{
                "type":"object",
                "properties":{
                    "entityId":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The system-generated unique identifier for the entity type.",
                        "example":"24797648086753"
                    },
                    "_link":{
                        "type":"string",
                        "maxLength":256,
                        "description":"Anchor Link"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

communication: object communication
info: string

Maximum Length: 1000

Contains relevant information about the communication log.

Example: 06-03-2022 05:20PM, Email, Brown, Robert, Primary Phone: 330-532-9834

{
    "type":"object",
    "properties":{
        "communication":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "communicationId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"The system-generated unique identifier for the communication log.",
                    "example":"17796561499666"
                }
            }
        },
        "info":{
            "type":"string",
            "maxLength":1000,
            "description":"Contains relevant information about the communication log.",
            "example":"06-03-2022 05:20PM, Email, Brown, Robert, Primary Phone: 330-532-9834"
        }
    }
}

Nested Schema : communication

Type: object

Show Source

_link: string

_link
communicationId: string

Maximum Length: 14

The system-generated unique identifier for the communication log.

Example: 17796561499666

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "communicationId":{
            "type":"string",
            "maxLength":14,
            "description":"The system-generated unique identifier for the communication log.",
            "example":"17796561499666"
        }
    }
}

Nested Schema : items

Type: object

Show Source

entity: object entity
entityType: string

Allowed Values: [ "W1WA", "W1WD", "W1WO", "W1WR" ]

Work documents created from the service call. * `W1WA` - Work Activity, * `W1WD` - Work Design, * `W1WO` - Work Order, * `W1WR` - Work Request

Example: W1WO
info: string

Maximum Length: 1000

Contains relevant information about the work document.

Example: Work Order: 20220000000213, Approved, Meter Read, 1 Activity

{
    "type":"object",
    "properties":{
        "entityType":{
            "type":"string",
            "enum":[
                "W1WA",
                "W1WD",
                "W1WO",
                "W1WR"
            ],
            "description":"Work documents created from the service call.\n* `W1WA` - Work Activity,\n* `W1WD` - Work Design,\n* `W1WO` - Work Order,\n* `W1WR` - Work Request",
            "example":"W1WO"
        },
        "info":{
            "type":"string",
            "maxLength":1000,
            "description":"Contains relevant information about the work document.",
            "example":"Work Order: 20220000000213, Approved, Meter Read, 1 Activity"
        },
        "entity":{
            "type":"object",
            "properties":{
                "entityId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The system-generated unique identifier for the entity type.",
                    "example":"24797648086753"
                },
                "_link":{
                    "type":"string",
                    "maxLength":256,
                    "description":"Anchor Link"
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

Show Source

_link: string

Maximum Length: 256

Anchor Link
entityId: string

Maximum Length: 254

The system-generated unique identifier for the entity type.

Example: 24797648086753

{
    "type":"object",
    "properties":{
        "entityId":{
            "type":"string",
            "maxLength":254,
            "description":"The system-generated unique identifier for the entity type.",
            "example":"24797648086753"
        },
        "_link":{
            "type":"string",
            "maxLength":256,
            "description":"Anchor Link"
        }
    }
}

400 Response

Bad Request

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}