Get activity links
get
/rest/ofscCore/v1/activities/{activityId}/linkedActivities
This operation retrieves the list of links for the specified activity.
Activity links define the correlation between two activities. If a link is created between two activities, it can define the following relations:
- The sequence in which the activities are performed. The basic link types allowed are finish-to-start, start-to-start, simultaneous, and related.
- The minimum and maximum intervals between sequential activities.
- Whether the linked activities are performed by the same resource or different resources.
For multi-day activities, only the Related link type is applicable.
Request
Path Parameters
-
activityId(required): string
The unique identifier of the activity in Oracle Field Service.
Response
Supported Media Types
- application/json
200 Response
This section describes the 200 status response for this operation.
Root Schema : Linked Activities
Type:
object
Title:
Linked Activities
The collection of activity-to-activity relations.
Show Source
-
activityId:
string
Title:
Activity ID
The identifier of the activity linked to the processed activity. -
items:
array Items
Title:
Items
An array of activity links for the specified activity. -
linkedActivityId:
string
Title:
Linked Activity ID
The identifier of the linked activity. -
linkType:
string
Title:
Link Type
The link type specified in the request.
Nested Schema : Items
Type:
array
Title:
Items
An array of activity links for the specified activity.
Show Source
-
Array of:
object Activity Link
Title:
Activity Link
The link represents the relation between two activities.
Nested Schema : Activity Link
Type:
object
Title:
Activity Link
The link represents the relation between two activities.
Show Source
-
alerts:
integer
Title:
Alerts
The bitmask of alert flags for the activity link. If the value returned is '0', then there are no alerts for the activity link. -
fromActivityId(required):
integer
Title:
From Activity ID
The identifier of the first linked activity. -
linkType(required):
string
Title:
Link Type
The link type specified in the request. -
maxIntervalValue:
integer
Title:
Max Interval
Minimum Value:0
Maximum Value:65535
The maximum time interval (in minutes) between subsequent linked activities, for the links that define the relative order of the activities. This parameter can only be sent if it is configured as "Adjustable" in the link template configuration. If the parameter is missing in the request, the value from the template wil be used. -
minIntervalValue:
integer
Title:
Min Interval
Minimum Value:0
Maximum Value:65535
The minimum time interval (in minutes) between subsequent linked activities, for the links that define the relative order of the activities. This parameter can only be sent if it is configured as "Adjustable" in the link template configuration. If the parameter is missing in the request, the value from the template wil be used. -
toActivityId(required):
integer
Title:
To Activity ID
The identifier of the second linked activity.
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
Show Source
object
-
detail:
string
The detailed description of this error.
-
status:
string
The HTTP status code of this error.
-
title(required):
string
The brief description of this error.
-
type(required):
string
The URL of the web page containing more details about this error.
Examples
The following example shows how to Get activity links by submitting a GET request on the REST resource using cURL.
curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' \ -H 'Accept: application/json' \ 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/activities/4225269/linkedActivities'
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Server: nginx/1.2.7 Date: Fri, 18 Mar 2016 02:24:07 GMT Content-Type: application/json; charset=utf-8 Connection: close
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "fromActivityId": 4225269, "toActivityId": 4225270, "linkType": "start-after", "alerts": 0, "links": [ { "rel": "canonical", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore//v1/activities/4225269/linkedActivities/4225270/linkTypes/start-after" } ] }, { "fromActivityId": 4225269, "toActivityId": 4225271, "linkType": "start-after", "alerts": 0, "links": [ { "rel": "canonical", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore//v1/activities/4225269/linkedActivities/4225271/linkTypes/start-after" } ] } ], "links": [ { "rel": "canonical", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore//v1/activities/4225269/linkedActivities" }, { "rel": "describedby", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore//v1/metadata-catalog/activities#definitions/linkedActivities" } ] }