Get a work order link
get
/crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/WoLink/{WoLinkId}
Request
Path Parameters
-
WoLinkId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
WoNumber(required): string
The alternate unique identifier of the work order. This value is system-generated, and is configured in the work order profile options SVC_WO_NUMBER PREFIX and SVC_WO_NUMBER_FORMAT. The default configuration is WO0000000000.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : customerWorkOrders-WoLink-item-response
Type:
Show Source
object
-
AssignmentConstraintCd: string
Title:
Assignment Constraints Code
Read Only:true
Maximum Length:30
The code that identifies the assignment constraint set on the link template. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the work order link. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of creating the work order link. -
FirstWoId: integer
(int64)
Title:
First Work Order ID
The unique identifier of the first work order in the link. -
FirstWoNumber: string
Title:
Reference Number
Read Only:true
Maximum Length:30
Value that uniquely identifies the alternate unique identifier of the first work order. This value is system-generated, and is configured in the work order profile options SVC_WO_NUMBER PREFIX and SVC_WO_NUMBER_FORMAT. The default configuration is WO0000000000. -
FirstWoScheduledDate: string
(date)
Title:
Scheduled Date
Read Only:true
The date when the scheduled service will be performed for the first work order. -
FirstWoScheduledTimeSlot: string
Title:
Scheduled Time Slot
Read Only:true
Maximum Length:40
The time slot to perform the scheduled service for the first work order. -
FirstWoStatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Indicates the work order status code for the first work order. -
FirstWoStatusCdMeaning: string
Title:
Status
Read Only:true
The meaning of the first work order status code. -
FirstWoTitle: string
Title:
Title
Read Only:true
Maximum Length:400
The title of the first work order. -
FsFirstActivityId: integer
(int64)
Title:
First Activity ID
The unique identifier of the corresponding first activity in Oracle Field Service Cloud for the work order activity. -
FsSecondActivityId: integer
(int64)
Title:
Second Activity ID
The unique identifier of the corresponding second activity in Oracle Field Service Cloud for the work order activity. -
LastUpdateDate: string
(date-time)
Title:
Object Version Number
Read Only:true
Indicates the date and time of last update for the work order link. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the work order link. -
LastUpdateSourceCd: string
Title:
Last Updated by Source
Maximum Length:30
The source who last updated the work order link. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LinkTemplateCatCd: string
Title:
Link Template Category Code
Read Only:true
Maximum Length:30
The code that identifies template category selected for this link template. -
LinkTemplateCatDirFirstCd: string
Title:
Link Template Category Direction Code for First Link
Read Only:true
Maximum Length:37
The code that identifies template category direction for the first link in this link template. -
LinkTemplateCatDirFirstCdMeaning: string
Title:
Link Template Category Direction for First Link
Read Only:true
Maximum Length:377
The meaning of the template category direction for the first link in this link template. -
LinkTemplateCatDirSecondCd: string
Title:
Link Template Category Direction Code for Second Link
Read Only:true
Maximum Length:37
The code that identifies template category direction for the second link in this link template. -
LinkTemplateCatDirSecondCdMeaning: string
Title:
Link Template Category Direction for Second Link
Read Only:true
Maximum Length:377
The meaning of the template category direction for the second link in this link template. -
LinkTemplateId: integer
(int64)
Title:
Link Template ID
The unique identifier of the link template in the link. -
LinkTemplateNumber: string
Title:
Link Template Number
Read Only:true
Maximum Length:30
Value that uniquely identifies the alternate unique identifier of the template number. This value can be system-generated, or can be configured. The default configuration is CDRM-0000000000. -
LinkTypeDirectionCd: string
Title:
Link Type Direction Code
Maximum Length:30
The code that identifies the direction of the link relationship, whether this link is for the first or second work order. -
LinkTypeLabelFirst: string
Title:
Link Label for First Work Order
Read Only:true
Maximum Length:160
The link type label that identifies the link for the first work order. This must exactly match the link label provided in the link template in Oracle Field Service. -
LinkTypeLabelSecond: string
Title:
Link Label for Second Work Order
Read Only:true
Maximum Length:160
The link type label that identifies the link for the second work order. This must exactly match the link label provided in the link template in Oracle Field Service. -
LinkTypeNameFirst: string
Title:
Link Name for First Work Order
Read Only:true
Maximum Length:256
The link type name that identifies the link for the first work order. -
LinkTypeNameSecond: string
Title:
Link Name for Second Work Order
Read Only:true
Maximum Length:256
The link type name that identifies the link for the second work order. -
MaximumIntervalMinutes: integer
(int32)
Title:
Maximum Interval (minutes)
Read Only:true
The default maximum interval in minutes. -
MaximumIntervalTypeCd: string
Title:
Maximum Interval Type Code
Read Only:true
Maximum Length:30
The code that identifies the maximum interval type between work order set on the link template. -
MaximumIntervalValue: integer
(int32)
Title:
Maximum Interval
The actual maximum interval in minutes for this link. -
MinimumIntervalMinutes: integer
(int32)
Title:
Minimum Interval (minutes)
Read Only:true
The default minimum interval in minutes. -
MinimumIntervalTypeCd: string
Title:
Minimum Interval Type Code
Read Only:true
Maximum Length:30
The code that identifies the minimum interval type between work order set on the link template. -
MinimumIntervalValue: integer
(int32)
Title:
Minimum Interval
The actual minimum interval in minutes for this link. -
SchedulingConstraintCd: string
Title:
Scheduling Constraints Code
Read Only:true
Maximum Length:30
The code that identifies the scheduling constraint set on the link template. -
SecondWoId: integer
(int64)
Title:
Second Work Order ID
The unique identifier of the second work order in the link. -
SecondWoNumber: string
Title:
Reference Number
Read Only:true
Maximum Length:30
Value that uniquely identifies the alternate unique identifier of the second work order. This value is system-generated, and is configured in the work order profile options SVC_WO_NUMBER PREFIX and SVC_WO_NUMBER_FORMAT. The default configuration is WO0000000000. -
SecondWoScheduledDate: string
(date)
Title:
Scheduled Date
Read Only:true
The date of when the scheduled service will be performed for the second work order. -
SecondWoScheduledTimeSlot: string
Title:
Scheduled Time Slot
Read Only:true
Maximum Length:40
The time slot to perform the scheduled service for the second work order. -
SecondWoStatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Indicates the work order status code for the second work order. -
SecondWoStatusCdMeaning: string
Title:
Status
Read Only:true
The meaning of the second work order status code. -
SecondWoTitle: string
Title:
Title
Read Only:true
Maximum Length:400
The title of the second work order. -
TemplateActiveFlag: boolean
Title:
Active
Read Only:true
Maximum Length:1
Default Value:false
Indicates if link template for the link is active. -
WoLinkId: integer
(int64)
Title:
Work Order Link ID
Read Only:true
The unique identifier of the work order link.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.