Jump to

• Request
• Response

Get a work zone configuration key

get

/crmRestApi/resources/11.13.18.05/workZoneConfigKeys/{WoKeyId}

Request

Path Parameters

• WoKeyId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to 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 : workZoneConfigKeys-item-response

Type: object

Show Source

• ConfigNumber: string
  Title: Configuration Number

  Maximum Length: 30

  The value that uniquely identifies alternate unique identifier of the work order area configuration that's associated to this work zone configuration key.
• ConnectionCd: string
  Title: Connection Code

  Maximum Length: 30

  Value that uniquely identifies the field service connection associated to this work zone configuration key.
• ConnectionName: string
  Title: Connection Name

  Read Only: true

  Maximum Length: 80

  The user defined name for the field service connection associated to this work zone configuration key.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the work zone configuration key.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the work zone configuration key was created.
• FsAPIParamName: string
  Title: Field Service API Parameter Name

  Maximum Length: 40

  Identifies the API parameter name for the Oracle Field Service property used in the Oracle Field Service work zone key.
• FsPropertyLabel: string
  Title: Field Service Property Label

  Maximum Length: 30

  Identifies the label for the Oracle Field Service property used in the Oracle Field Service work zone key.
• FsPropertyName: string
  Title: Field Service Property Name

  Maximum Length: 30

  Default Value: NEW

  Identifies the name for the Oracle Field Service property used in the Oracle Field Service work zone key.
• FsPropertyType: string
  Title: Property Type

  Maximum Length: 30

  Identifies the type for the Oracle Field Service property used in the Oracle Field Service work zone key.
• FsWorkZoneKey: string
  Title: Field Service Work Zone Key

  Read Only: true

  Maximum Length: 30

  Identifies the work zone key name in Oracle Field Service. This is the same as property name.
• FsWorkZoneKeyCase: string
  Title: Field Service Work Zone Key Case

  Maximum Length: 30

  Identifies Oracle Field Service work zone key case sensitivity.
• FsWorkZoneKeyLength: integer (int32)
  Title: Length

  Identifies Oracle Field Service work zone key length.
• FsWorkZoneKeyOrder: integer (int32)
  Title: Order

  Identifies Oracle Field Service work zone key order.
• InitiateRetrievalFlag: boolean
  Title: Initiate Retrieval

  Default Value: false

  Indicates whether there is a request to initiate a retrieval for work zone key from Oracle Field Service.
• KeyTypeCd: string
  Title: Configuration Key Type Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_WORK_ZONE

  The code that identifies the type of configuration key. This is always set to ORA_SVC_WORK_ZONE.
• KeyTypeCdMeaning: string
  Title: Configuration Key Type

  Read Only: true

  Maximum Length: 80

  The name for the type of configuration key selected. This is the name given for the ORA_SVC_WORK_ZONE code.
• LastRetrievalDate: string (date-time)
  Title: Last Retrieval Date.

  Read Only: true

  The date and time when the work zone configuration key was last retrieved.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Indicates the date and time when the work zone configuration key was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the work zone configuration key.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• WoField: string
  Title: Work Order Field

  Maximum Length: 30

  Identifies the work order field in Service that's associated to the Oracle Field Service work zone key.
• WoKeyId: integer (int64)
  Read Only: true

  The unique identifier of the work zone configuration key.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the work zone configuration key.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InitiateRetrievalFlag":{
            "title":"Initiate Retrieval",
            "type":"boolean",
            "description":"Indicates whether there is a request to initiate a retrieval for work zone key from Oracle Field Service.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "FsAPIParamName":{
            "title":"Field Service API Parameter Name",
            "maxLength":"40",
            "type":"string",
            "description":"Identifies the API parameter name for the Oracle Field Service property used in the Oracle Field Service work zone key.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the work zone configuration key was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KeyTypeCdMeaning":{
            "title":"Configuration Key Type",
            "maxLength":"80",
            "type":"string",
            "description":"The name for the type of configuration key selected. This is the name given for the ORA_SVC_WORK_ZONE code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "KeyTypeCd"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the work zone configuration key.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FsWorkZoneKeyCase":{
            "title":"Field Service Work Zone Key Case",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies Oracle Field Service work zone key case sensitivity.",
            "nullable":true,
            "x-queryable":true
        },
        "FsWorkZoneKeyLength":{
            "title":"Length",
            "type":"integer",
            "description":"Identifies Oracle Field Service work zone key length.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "LastRetrievalDate":{
            "title":"Last Retrieval Date.",
            "type":"string",
            "description":"The date and time when the work zone configuration key was last retrieved.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FsWorkZoneKeyOrder":{
            "title":"Order",
            "type":"integer",
            "description":"Identifies Oracle Field Service work zone key order.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "FsPropertyName":{
            "title":"Field Service Property Name",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the name for the Oracle Field Service property used in the Oracle Field Service work zone key.",
            "nullable":false,
            "default":"NEW",
            "x-queryable":true
        },
        "ConnectionName":{
            "title":"Connection Name",
            "maxLength":"80",
            "type":"string",
            "description":"The user defined name for the field service connection associated to this work zone configuration key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ConnectionCd"
                ]
            }
        },
        "WoField":{
            "title":"Work Order Field",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the work order field in Service that's associated to the Oracle Field Service work zone key.",
            "nullable":true,
            "x-queryable":true
        },
        "KeyTypeCd":{
            "title":"Configuration Key Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the type of configuration key. This is always set to ORA_SVC_WORK_ZONE.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_WORK_ZONE",
            "x-queryable":true
        },
        "ConnectionCd":{
            "title":"Connection Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the field service connection associated to this work zone configuration key.",
            "nullable":false,
            "x-queryable":true
        },
        "FsWorkZoneKey":{
            "title":"Field Service Work Zone Key",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the work zone key name in Oracle Field Service. This is the same as property name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FsPropertyName"
                ]
            },
            "x-queryable":true
        },
        "FsPropertyType":{
            "title":"Property Type",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the type for the Oracle Field Service property used in the Oracle Field Service work zone key.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WoKeyId":{
            "type":"integer",
            "description":"The unique identifier of the work zone configuration key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FsPropertyLabel":{
            "title":"Field Service Property Label",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the label for the Oracle Field Service property used in the Oracle Field Service work zone key.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfigNumber":{
            "title":"Configuration Number",
            "maxLength":"30",
            "type":"string",
            "description":"The value that uniquely identifies alternate unique identifier of the work order area configuration that's associated to this work zone configuration key.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time when the work zone configuration key was last updated.",
            "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