Jump to

• Request
• Response

Get a connection

get

/crmRestApi/resources/11.13.18.05/fieldServiceConnections/{ConnectionCd}

Request

Path Parameters

• ConnectionCd(required): string
  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=

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

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 : fieldServiceConnections-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the connection is active.
• ConnectionCd: string
  Title: Connection Code

  Maximum Length: 30

  Value that uniquely identifies the alternate unique identifier for the connection.
• ConnectionId: integer (int64)
  Title: Connection ID

  Read Only: true

  The unique identifier of the connection.
• ConnectionName: string
  Title: Connection Name

  Maximum Length: 80

  The user defined name for the connection.
• ConnectionTypeCd: string
  Title: Connection Type Code

  Maximum Length: 30

  The code that identifies the type of connection.
• ConnectionTypeCdMeaning: string
  Title: Connection Type

  Read Only: true

  The name of the connection type selected for this connection.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the connection.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the connection was created.
• DaBookingAvailableFlag: boolean
  Title: Direct Assignment Booking Available

  Read Only: true

  Maximum Length: 1

  Indicates whether direct assignment booking is available for a Oracle Field Service connection.
• DaBookingAvailableMsgCd: string
  Title: Direct Assignment Booking Available Message Code

  Read Only: true

  Maximum Length: 30

  The message code that identifies the reason if direct assignment booking isn't available from Oracle Field Service.
• DaBookingAvailMessage: string
  Title: Direct Assignment Booking Available Message

  Read Only: true

  Maximum Length: 2000

  The message providing the reason if direct assignment booking isn't available from Oracle Field Service.
• FsInstanceName: string
  Title: Field Service Instance Name

  Maximum Length: 24

  The field service instance name.
• InitiateVerificationFlag: boolean
  Title: Initiate Verification

  Maximum Length: 1

  Default Value: false

  Indicates whether there is a request to initiate the verification.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Indicates the date and time when the connection was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the connection.
• LastVerifiedDate: string (date-time)
  Title: Last Verified Date

  Read Only: true

  The date and time when the connection was last verified.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Password: string
  Title: Password

  Maximum Length: 80

  The password prompt used when creating a connection to pass the password details in.
• QbBookingAvailableFlag: boolean
  Title: Capacity Based Booking Available

  Read Only: true

  Maximum Length: 1

  Indicates whether capacity based booking is available for a Oracle Field Service connection.
• QbBookingAvailableMsgCd: string
  Title: Capacity Based Booking Available Message Code

  Read Only: true

  Maximum Length: 30

  The message code that identifies the reason if capacity based booking isn't available from Oracle Field Service.
• QbBookingAvailMessage: string
  Title: Capacity Based Booking Available Message

  Read Only: true

  Maximum Length: 2000

  The message that identifies the reason if capacity based booking isn't available from Oracle Field Service.
• URL: string
  Title: URL

  Maximum Length: 250

  The url used to make the connection.
• UserName: string
  Title: User Name

  Maximum Length: 64

  The name of the user used to make the connection.
• WaRetrievalAvailableFlag: boolean
  Title: Work Order Area Retrieval Available

  Read Only: true

  Maximum Length: 1

  Indicates whether the work order area retrieval is available for a Oracle Field Service connection.
• WaRetrievalAvailableMsgCd: string
  Title: Work Order Area Retrieval Available Message Code

  Read Only: true

  Maximum Length: 30

  The message code that identifies the reason if work order area retrieval isn't available from Oracle Field Service.
• WaRetrievalAvailMessage: string
  Title: Work Order Area Retrieval Available Message

  Read Only: true

  Maximum Length: 2000

  The message that identifies the reason if work order area retrieval isn't available from Oracle Field Service.
• WskillRetrievalAvailFlag: boolean
  Title: Work Skill Retrieval Available

  Read Only: true

  Maximum Length: 1

  Indicates whether the work skill retrieval is available for a Oracle Field Service connection.
• WskillRetrievalAvailMessage: string
  Title: Work Skill Retrieval Available Message

  Read Only: true

  Maximum Length: 2000

  The message that identifies the reason if work skill retrieval isn't available from Oracle Field Service.
• WskillRetrievalAvailMsgCd: string
  Title: Work Skill Retrieval Available Message Code

  Read Only: true

  Maximum Length: 30

  The message code that identifies the reason if work skill retrieval isn't available from Oracle Field Service.
• WzoneRetrievalAvailFlag: boolean
  Title: Work Zone Retrieval Available

  Read Only: true

  Maximum Length: 1

  Indicates whether the work zone retrieval is available for a Oracle Field Service connection.
• WzoneRetrievalAvailMessage: string
  Title: Work Zone Retrieval Available Message

  Read Only: true

  Maximum Length: 2000

  The message that identifies the reason if work zone retrieval isn't available from Oracle Field Service.
• WzoneRetrievalAvailMsgCd: string
  Title: Work Zone Retrieval Available Message Code

  Read Only: true

  Maximum Length: 30

  The message code that identifies the reason if work zone retrieval isn't available from Oracle Field Service.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the connection is active.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConnectionCd":{
            "title":"Connection Code",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the alternate unique identifier for the connection.",
            "nullable":false,
            "x-queryable":true
        },
        "ConnectionId":{
            "title":"Connection ID",
            "type":"integer",
            "description":"The unique identifier of the connection.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConnectionName":{
            "title":"Connection Name",
            "maxLength":80,
            "type":"string",
            "description":"The user defined name for the connection.",
            "nullable":false,
            "x-queryable":true
        },
        "ConnectionTypeCd":{
            "title":"Connection Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the type of connection.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConnectionTypeCdMeaning":{
            "title":"Connection Type",
            "type":"string",
            "description":"The name of the connection type selected for this connection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ConnectionTypeCd"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the connection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the connection was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DaBookingAvailMessage":{
            "title":"Direct Assignment Booking Available Message",
            "maxLength":2000,
            "type":"string",
            "description":"The message providing the reason if direct assignment booking isn't available from Oracle Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DaBookingAvailableFlag":{
            "title":"Direct Assignment Booking Available",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether direct assignment booking is available for a Oracle Field Service connection.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DaBookingAvailableMsgCd":{
            "title":"Direct Assignment Booking Available Message Code",
            "maxLength":30,
            "type":"string",
            "description":"The message code that identifies the reason if direct assignment booking isn't available from Oracle Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FsInstanceName":{
            "title":"Field Service Instance Name",
            "maxLength":24,
            "type":"string",
            "description":"The field service instance name.",
            "nullable":true,
            "x-queryable":true
        },
        "InitiateVerificationFlag":{
            "title":"Initiate Verification",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether there is a request to initiate the verification.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time when the connection was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the connection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastVerifiedDate":{
            "title":"Last Verified Date",
            "type":"string",
            "description":"The date and time when the connection was last verified.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Password":{
            "title":"Password",
            "maxLength":80,
            "type":"string",
            "description":"The password prompt used when creating a connection to pass the password details in.",
            "nullable":false,
            "x-queryable":false
        },
        "QbBookingAvailMessage":{
            "title":"Capacity Based Booking Available Message",
            "maxLength":2000,
            "type":"string",
            "description":"The message that identifies the reason if capacity based booking isn't available from Oracle Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QbBookingAvailableFlag":{
            "title":"Capacity Based Booking Available",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether capacity based booking is available for a Oracle Field Service connection.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "QbBookingAvailableMsgCd":{
            "title":"Capacity Based Booking Available Message Code",
            "maxLength":30,
            "type":"string",
            "description":"The message code that identifies the reason if capacity based booking isn't available from Oracle Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "URL":{
            "title":"URL",
            "maxLength":250,
            "type":"string",
            "description":"The url used to make the connection.",
            "nullable":true,
            "x-queryable":false
        },
        "UserName":{
            "title":"User Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user used to make the connection.",
            "nullable":false,
            "x-queryable":true
        },
        "WaRetrievalAvailMessage":{
            "title":"Work Order Area Retrieval Available Message",
            "maxLength":2000,
            "type":"string",
            "description":"The message that identifies the reason if work order area retrieval isn't available from Oracle Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WaRetrievalAvailableFlag":{
            "title":"Work Order Area Retrieval Available",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order area retrieval is available for a Oracle Field Service connection.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WaRetrievalAvailableMsgCd":{
            "title":"Work Order Area Retrieval Available Message Code",
            "maxLength":30,
            "type":"string",
            "description":"The message code that identifies the reason if work order area retrieval isn't available from Oracle Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WskillRetrievalAvailFlag":{
            "title":"Work Skill Retrieval Available",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work skill retrieval is available for a Oracle Field Service connection.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WskillRetrievalAvailMessage":{
            "title":"Work Skill Retrieval Available Message",
            "maxLength":2000,
            "type":"string",
            "description":"The message that identifies the reason if work skill retrieval isn't available from Oracle Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WskillRetrievalAvailMsgCd":{
            "title":"Work Skill Retrieval Available Message Code",
            "maxLength":30,
            "type":"string",
            "description":"The message code that identifies the reason if work skill retrieval isn't available from Oracle Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WzoneRetrievalAvailFlag":{
            "title":"Work Zone Retrieval Available",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work zone retrieval is available for a Oracle Field Service connection.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WzoneRetrievalAvailMessage":{
            "title":"Work Zone Retrieval Available Message",
            "maxLength":2000,
            "type":"string",
            "description":"The message that identifies the reason if work zone retrieval isn't available from Oracle Field Service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WzoneRetrievalAvailMsgCd":{
            "title":"Work Zone Retrieval Available Message Code",
            "maxLength":30,
            "type":"string",
            "description":"The message code that identifies the reason if work zone retrieval isn't available from Oracle Field Service.",
            "nullable":true,
            "readOnly":true,
            "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