Jump to

• Request
• Response

Update a work order link

patch

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

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• FirstWoId: integer (int64)
  Title: First Work Order ID

  The unique identifier of the first work order in the link.
• 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.
• LastUpdateSourceCd: string
  Title: Last Updated by Source

  Maximum Length: 30

  The source who last updated the work order link.
• LinkTemplateId: integer (int64)
  Title: Link Template ID

  The unique identifier of the link template in the link.
• 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.
• MaximumIntervalValue: integer (int32)
  Title: Maximum Interval

  The actual maximum interval in minutes for this link.
• MinimumIntervalValue: integer (int32)
  Title: Minimum Interval

  The actual minimum interval in minutes for this link.
• SecondWoId: integer (int64)
  Title: Second Work Order ID

  The unique identifier of the second work order in the link.

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "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"
                ]
            }
        },
        "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"
                ]
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "MaximumIntervalValue":{
            "title":"Maximum Interval",
            "type":"integer",
            "description":"The actual maximum interval in minutes for this link.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "MinimumIntervalValue":{
            "title":"Minimum Interval",
            "type":"integer",
            "description":"The actual minimum interval in minutes for this link.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "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
            }
        }
    }
}

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-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":{
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the work order link.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
                ]
            }
        },
        "FirstWoTitle":{
            "title":"Title",
            "maxLength":400,
            "type":"string",
            "description":"The title of the first work order.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
                ]
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
                ]
            }
        },
        "SecondWoTitle":{
            "title":"Title",
            "maxLength":400,
            "type":"string",
            "description":"The title of the second work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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