Jump to

• Request
• Response

Get all work order links

get

/crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/WoLink

Request

Path Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey :Finds a work order link based on the specified work order link unique identifier.
    Finder Variables:
    • WoLinkId :The unique identifier of the work order link.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignmentConstraintCd; string; The code that identifies the assignment constraint set on the link template.
  • CreatedBy; string; The user who created the work order link.
  • CreationDate; string; The date and time of creating the work order link.
  • FirstWoId; integer; The unique identifier of the first work order in the link.
  • FirstWoNumber; string; 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; The date when the scheduled service will be performed for the first work order.
  • FirstWoScheduledTimeSlot; string; The time slot to perform the scheduled service for the first work order.
  • FirstWoStatusCd; string; Indicates the work order status code for the first work order.
  • FirstWoTitle; string; The title of the first work order.
  • FsFirstActivityId; integer; The unique identifier of the corresponding first activity in Oracle Field Service Cloud for the work order activity.
  • FsSecondActivityId; integer; The unique identifier of the corresponding second activity in Oracle Field Service Cloud for the work order activity.
  • LastUpdateDate; string; Indicates the date and time of last update for the work order link.
  • LastUpdateSourceCd; string; The source who last updated the work order link.
  • LastUpdatedBy; string; The user who last updated the work order link.
  • LinkTemplateCatCd; string; The code that identifies template category selected for this link template.
  • LinkTemplateCatDirFirstCd; string; The code that identifies template category direction for the first link in this link template.
  • LinkTemplateCatDirFirstCdMeaning; string; The meaning of the template category direction for the first link in this link template.
  • LinkTemplateCatDirSecondCd; string; The code that identifies template category direction for the second link in this link template.
  • LinkTemplateId; integer; The unique identifier of the link template in the link.
  • LinkTemplateNumber; string; 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; The code that identifies the direction of the link relationship, whether this link is for the first or second work order.
  • LinkTypeLabelFirst; string; 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; 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; The link type name that identifies the link for the first work order.
  • LinkTypeNameSecond; string; The link type name that identifies the link for the second work order.
  • MaximumIntervalMinutes; integer; The default maximum interval in minutes.
  • MaximumIntervalTypeCd; string; The code that identifies the maximum interval type between work order set on the link template.
  • MaximumIntervalValue; integer; The actual maximum interval in minutes for this link.
  • MinimumIntervalMinutes; integer; The default minimum interval in minutes.
  • MinimumIntervalTypeCd; string; The code that identifies the minimum interval type between work order set on the link template.
  • MinimumIntervalValue; integer; The actual minimum interval in minutes for this link.
  • SchedulingConstraintCd; string; The code that identifies the scheduling constraint set on the link template.
  • SecondWoId; integer; The unique identifier of the second work order in the link.
  • SecondWoNumber; string; 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; The date of when the scheduled service will be performed for the second work order.
  • SecondWoScheduledTimeSlot; string; The time slot to perform the scheduled service for the second work order.
  • SecondWoStatusCd; string; Indicates the work order status code for the second work order.
  • SecondWoTitle; string; The title of the second work order.
  • TemplateActiveFlag; boolean; Indicates if link template for the link is active.
  • WoLinkId; integer; The unique identifier of the work order link.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 Top

Response

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.

Body ()

Root Schema : customerWorkOrders-WoLink

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/customerWorkOrders-WoLink-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object customerWorkOrders-WoLink-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/customerWorkOrders-WoLink-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : customerWorkOrders-WoLink-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TemplateActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if link template for the link is active.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of creating the work order link.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateSourceCd":{
            "title":"Last Updated by Source",
            "maxLength":"30",
            "type":"string",
            "description":"The source who last updated the work order link.",
            "nullable":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "LinkTypeNameFirst":{
            "title":"Link Name for First Work Order",
            "maxLength":"256",
            "type":"string",
            "description":"The link type name that identifies the link for the first work order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "WoLinkId":{
            "title":"Work Order Link ID",
            "type":"integer",
            "description":"The unique identifier of the work order link.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FirstWoStatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the work order status code for the first work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FsFirstActivityId":{
            "title":"First Activity ID",
            "type":"integer",
            "description":"The unique identifier of the corresponding first activity in Oracle Field Service Cloud for the work order activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "FirstWoId"
                ]
            },
            "x-queryable":true
        },
        "SecondWoScheduledTimeSlot":{
            "title":"Scheduled Time Slot",
            "maxLength":"40",
            "type":"string",
            "description":"The time slot to perform the scheduled service for the second work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTemplateCatCd":{
            "title":"Link Template Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies template category selected for this link template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTypeLabelFirst":{
            "title":"Link Label for First Work Order",
            "maxLength":"160",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FsSecondActivityId":{
            "title":"Second Activity ID",
            "type":"integer",
            "description":"The unique identifier of the corresponding second activity in Oracle Field Service Cloud for the work order activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "SecondWoId"
                ]
            },
            "x-queryable":true
        },
        "FirstWoNumber":{
            "title":"Reference Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTemplateNumber":{
            "title":"Link Template Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumIntervalMinutes":{
            "title":"Maximum Interval (minutes)",
            "type":"integer",
            "description":"The default maximum interval in minutes.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SecondWoId":{
            "title":"Second Work Order ID",
            "type":"integer",
            "description":"The unique identifier of the second work order in the link.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumIntervalValue":{
            "title":"Maximum Interval",
            "type":"integer",
            "description":"The actual maximum interval in minutes for this link.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SecondWoScheduledDate":{
            "title":"Scheduled Date",
            "type":"string",
            "description":"The date of when the scheduled service will be performed for the second work order.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTemplateCatDirSecondCd":{
            "title":"Link Template Category Direction Code for Second Link",
            "maxLength":"37",
            "type":"string",
            "description":"The code that identifies template category direction for the second link in this link template.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LinkTemplateCatCd"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LinkTypeNameSecond":{
            "title":"Link Name for Second Work Order",
            "maxLength":"256",
            "type":"string",
            "description":"The link type name that identifies the link for the second work order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "SchedulingConstraintCd":{
            "title":"Scheduling Constraints Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the scheduling constraint set on the link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondWoTitle":{
            "title":"Title",
            "maxLength":"400",
            "type":"string",
            "description":"The title of the second work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTemplateCatDirSecondCdMeaning":{
            "title":"Link Template Category Direction for Second Link",
            "maxLength":"377",
            "type":"string",
            "description":"The meaning of the template category direction for the second link in this link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LinkTemplateCatDirSecondCd"
                ]
            }
        },
        "MaximumIntervalTypeCd":{
            "title":"Maximum Interval Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the maximum interval type between work order set on the link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstWoScheduledDate":{
            "title":"Scheduled Date",
            "type":"string",
            "description":"The date when the scheduled service will be performed for the first work order.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the work order link.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentConstraintCd":{
            "title":"Assignment Constraints Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the assignment constraint set on the link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumIntervalValue":{
            "title":"Minimum Interval",
            "type":"integer",
            "description":"The actual minimum interval in minutes for this link.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LinkTemplateCatDirFirstCdMeaning":{
            "title":"Link Template Category Direction for First Link",
            "maxLength":"377",
            "type":"string",
            "description":"The meaning of the template category direction for the first link in this link template.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LinkTemplateCatDirFirstCd"
                ]
            },
            "x-queryable":true
        },
        "FirstWoId":{
            "title":"First Work Order ID",
            "type":"integer",
            "description":"The unique identifier of the first work order in the link.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the work order link.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTemplateCatDirFirstCd":{
            "title":"Link Template Category Direction Code for First Link",
            "maxLength":"37",
            "type":"string",
            "description":"The code that identifies template category direction for the first link in this link template.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LinkTemplateCatCd"
                ]
            },
            "x-queryable":true
        },
        "LinkTemplateId":{
            "title":"Link Template ID",
            "type":"integer",
            "description":"The unique identifier of the link template in the link.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FirstWoTitle":{
            "title":"Title",
            "maxLength":"400",
            "type":"string",
            "description":"The title of the first work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstWoStatusCdMeaning":{
            "title":"Status",
            "type":"string",
            "description":"The meaning of the first work order status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "FirstWoStatusCd"
                ]
            }
        },
        "MinimumIntervalTypeCd":{
            "title":"Minimum Interval Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the minimum interval type between work order set on the link template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTypeLabelSecond":{
            "title":"Link Label for Second Work Order",
            "maxLength":"160",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstWoScheduledTimeSlot":{
            "title":"Scheduled Time Slot",
            "maxLength":"40",
            "type":"string",
            "description":"The time slot to perform the scheduled service for the first work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumIntervalMinutes":{
            "title":"Minimum Interval (minutes)",
            "type":"integer",
            "description":"The default minimum interval in minutes.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SecondWoNumber":{
            "title":"Reference Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkTypeDirectionCd":{
            "title":"Link Type Direction Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the direction of the link relationship, whether this link is for the first or second work order.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SecondWoStatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the work order status code for the second work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondWoStatusCdMeaning":{
            "title":"Status",
            "type":"string",
            "description":"The meaning of the second work order status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "FirstWoStatusCd"
                ]
            }
        },
        "LastUpdateDate":{
            "title":"Object Version Number",
            "type":"string",
            "description":"Indicates the date and time of last update for the work order link.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top