Retrieve Pending Tasks
post
https://server:port/spl/rest/apis/cross/service/appointmentTasks/tasks
This Operation handles the Integration Suite API to Search Appointment Tasks.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page Limit -
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page Offset
Nested Schema : account
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The system-generated unique identifier of an account.Example:1589809032
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page Limit -
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page Offset
Nested Schema : account
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The system-generated unique identifier of an account.Example:1589809032
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1PenAppList
Type:
Show Source
object
-
account: object
account
-
appointmentList: array
appointmentList
-
limit: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page Limit -
offset: number
Minimum Value:
0
Maximum Value:9.99999999999999E8
Page Offset -
totalNumberOfRecords: number
Minimum Value:
0
Maximum Value:99999
Total Number Of Records
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
The system-generated unique identifier of an account.Example:1589809032
Nested Schema : items
Type:
Show Source
object
-
address: object
address
-
appointmentEndDateTime: string
(date-time)
Field Activity's appointment stop Date/Time.Example:
04-12-2021 08:00:00AM
-
appointmentStartDateTime: string
(date-time)
Field Activity's appointment start Date/Time.Example:
04-10-2021 08:00:00AM
-
fieldActivity: object
fieldActivity
-
fieldTaskType: string
Maximum Length:
254
Defines details about the type of task to be performed and how the system will process the activity.Example:ZZ-FaTypKK
-
fieldTaskTypeDescription: string
Maximum Length:
60
Description for the Field Task Type.Example:Test Field Task Type - KK
-
isAppointmentSet: boolean
Flag to show if appointment has already been booked for field activities.Example:
true
-
isStartStopEvent: boolean
Indicates if the appointment is a start or stop service event. A value of true indicates a start or stop service event.Example:
true
-
meterId: object
meterId
The unique system identifier of additional equipment installed at the service point.
-
referenceId: string
Maximum Length:
30
Unique identifier for a service task created for an appointment.Example:58340022155822
-
serviceDate: string
(date-time)
Field Activity's start Date/Time.
-
servicePoint: object
servicePoint
-
servicePointType: object
servicePointType
Indicates the category of the device location where the service is delivered.
-
serviceType: object
serviceType
Service Type defines the type of service associated with the SA type.
Nested Schema : address
Type:
Show Source
object
-
address1: string
Maximum Length:
254
The first line of the address. -
address2: string
Maximum Length:
254
The second line of the address. -
address3: string
Maximum Length:
254
The third line of the address. -
address4: string
Maximum Length:
254
The fourth line of the address. -
city: string
Maximum Length:
90
The city of the address.Example:San Francisco
-
country: object
country
The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.
-
county: string
Maximum Length:
90
The county of the address.Example:San Francisco
-
geographic: string
Maximum Length:
11
Defines the physical address location that is used to apply proper taxation rules. -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
Indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
inCityLimit: boolean
Indicates if the address is considered within the physical limits of a city. A value of true indicates within city limits.Example:
true
-
number1: string
Maximum Length:
6
The first street number line of the address. -
number2: string
Maximum Length:
4
The second street number line of the address. -
postal: string
Maximum Length:
12
The postal code of the address. -
state: string
Maximum Length:
6
The state of the address.Example:CA
Nested Schema : fieldActivity
Type:
Show Source
object
-
_link: string
_link
-
fieldActivityId: string
Maximum Length:
10
The system-generated unique identifier for the field activity request.Example:48269690619977
Nested Schema : meterId
Type:
object
The unique system identifier of additional equipment installed at the service point.
Show Source
-
_link: string
_link
-
badgeNumber: string
Maximum Length:
120
The unique system identifier of additional equipment installed at the service point.Example:BN20_YC_7529
-
meterId: string
Maximum Length:
12
The unique system identifier of additional equipment installed at the service point.Example:BN20_YC_7529
Nested Schema : servicePoint
Type:
Show Source
object
-
_link: string
_link
-
servicePointId: string
Maximum Length:
10
Indicates the service point where the activity takes place.Example:214672087211
-
timeZone: string
Maximum Length:
10
Indicates the service point where the activity takes place.Example:214672087211
-
timeZoneDescription: string
Maximum Length:
60
Indicates the service point where the activity takes place.Example:214672087211
-
timeZoneName: string
Maximum Length:
50
Indicates the service point where the activity takes place.Example:214672087211
Nested Schema : servicePointType
Type:
object
Indicates the category of the device location where the service is delivered.
Show Source
-
_link: string
_link
-
servicePointType: string
Maximum Length:
30
Indicates the category of the device location where the service is delivered.Example:ZZ_ERT_ITM_SP_TYPE_01
-
servicePointTypeDescription: string
Maximum Length:
50
Indicates the category of the device location where the service is delivered.Example:ZZ_ERT_ITM_SP_TYPE_01
Nested Schema : serviceType
Type:
object
Service Type defines the type of service associated with the SA type.
Show Source
-
_link: string
_link
-
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the SA type.Example:E
-
serviceTypeDescription: string
Maximum Length:
100
Service Type defines the type of service associated with the SA type.Example:E
Nested Schema : country
Type:
object
The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.
Show Source
-
_link: string
_link
-
country: string
Maximum Length:
3
The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.
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.