Get Work Activity
get
https://server:port/rest/apis/asset/work/workActivity/{activityId}
Retrieves activity details for project planning, not including attachments.
Request
Path Parameters
-
activityId(required): string
System generated primary key up to 14 numeric digit identifier for the work activity record.Example:
01678656581367
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response. The request was successfully completed. A 200 status is returned for a successful GET method.
Nested Schema : activity
Type:
Show Source
object
-
activityDetails: object
activityDetails
-
activityId: string
Maximum Length:
14
Activity -
bo: string
Maximum Length:
30
Business Object -
boStatus: string
Maximum Length:
12
Status
Nested Schema : activityDetails
Type:
Show Source
object
-
activityNumber: number
Minimum Value:
0
Maximum Value:99999
Activity Number -
activityType: string
Maximum Length:
30
Activity Type -
activityTypeDesc: string
Maximum Length:
100
Description -
craftSummaryInfo: string
Maximum Length:
1073741824
Business Object Data Area -
description: string
Maximum Length:
100
Description -
emergency: string
Allowed Values:
[ "W1NO", "W1YS" ]
Emergency: * `W1NO` - No, * `W1YS` - Yes -
equipmentGroup: object
equipmentGroup
-
info: string
Maximum Length:
1073741824
Business Object Data Area -
laborGroup: object
laborGroup
-
longDescription: string
Maximum Length:
4000
Detailed Description -
otherGroup: object
otherGroup
-
projectDetails: object
projectDetails
-
requestor: string
Maximum Length:
8
Requestor -
requestorInfo: string
Maximum Length:
1
Info -
requiredByDate: string
(date)
Required By Date
-
storeroomGroup: object
storeroomGroup
-
totalPriority: number
Minimum Value:
0
Maximum Value:99
Total Risk Priority -
windowEndDateTime: string
(date-time)
Work Window End Date/Time
-
windowStartDateTime: string
(date-time)
Work Window Start Date/Time
-
workorderdetails: object
workorderdetails
Nested Schema : projectDetails
Type:
Show Source
object
-
description: string
Maximum Length:
100
Description -
externalId: string
Maximum Length:
60
External ID -
projectId: string
Maximum Length:
12
Project -
projectNumber: string
Maximum Length:
14
Project Number
Nested Schema : workorderdetails
Type:
Show Source
object
-
description: string
Maximum Length:
100
Description -
workOrderId: string
Maximum Length:
14
Work Order -
workOrderNumber: string
Maximum Length:
14
Work Order Number
Nested Schema : items
Type:
Show Source
object
-
activityResourceRequirementId: string
Maximum Length:
14
Activity Resource Requirement -
detailedDescription: string
Maximum Length:
4000
Detailed Description -
duration: number
Minimum Value:
0
Maximum Value:9.999999999999E10
Duration -
equipment: string
Maximum Length:
12
Resource Type -
equipmentCode: string
Maximum Length:
60
Identifier Value -
info: string
Maximum Length:
1073741824
Business Object Data Area -
quantity: number
Minimum Value:
0
Maximum Value:9.999999999999E7
Quantity -
resourceTypeDescription: string
Maximum Length:
100
Description -
uom: string
Maximum Length:
30
Resource UOM
Nested Schema : items
Type:
Show Source
object
-
activityResourceRequirementId: string
Maximum Length:
14
Activity Resource Requirement -
craft: string
Maximum Length:
12
Resource Type -
craftCode: string
Maximum Length:
60
Identifier Value -
detailedDescription: string
Maximum Length:
4000
Detailed Description -
duration: number
Minimum Value:
0
Maximum Value:9.999999999999E10
Duration -
info: string
Maximum Length:
1073741824
Business Object Data Area -
quantity: number
Minimum Value:
0
Maximum Value:9.999999999999E7
Quantity -
resourceTypeDescription: string
Maximum Length:
100
Description
Nested Schema : items
Type:
Show Source
object
-
activityResourceRequirementId: string
Maximum Length:
14
Activity Resource Requirement -
detailedDescription: string
Maximum Length:
4000
Detailed Description -
info: string
Maximum Length:
1073741824
Business Object Data Area -
other: string
Maximum Length:
12
Resource Type -
otherResourceCode: string
Maximum Length:
60
Identifier Value -
quantity: number
Minimum Value:
0
Maximum Value:9.999999999999E7
Quantity -
resourceTypeDescription: string
Maximum Length:
100
Description -
uom: string
Maximum Length:
30
Resource UOM
Nested Schema : items
Type:
Show Source
object
-
materialGroup: object
materialGroup
-
nodeId: string
Maximum Length:
12
Location/Organization -
storeroomInfo: string
Maximum Length:
1073741824
Business Object Data Area
Nested Schema : items
Type:
Show Source
object
-
activityResourceRequirementId: string
Maximum Length:
14
Activity Resource Requirement -
detailedDescription: string
Maximum Length:
4000
Detailed Description -
info: string
Maximum Length:
1073741824
Business Object Data Area -
quantity: number
Minimum Value:
0
Maximum Value:9.999999999999E7
Quantity -
resourceTypeDescription: string
Maximum Length:
100
Description -
stockItem: string
Maximum Length:
60
Identifier Value -
stockItemId: string
Maximum Length:
12
Resource Type -
uom: string
Maximum Length:
30
Resource UOM
400 Response
Bad Request. The request could not be processed because it contains missing or invalid information (such as a validation error on an input field, a missing required value, and so on).
Nested 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. The server encountered an unexpected condition that prevented it from fulfilling the request.
Nested 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.