Jump to

• Request
• Response

Update a tracking service

patch

/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}

Request

Path Parameters

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

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

• authArtifacts: array Authorization Artifacts
  Title: Authorization Artifacts

  The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.
• Protocol: string
  Maximum Length: 80

  Text that identifies the service type. Developers should use the value TrackingServicesBridge for external systems that transfer data from fitness tracking services to Oracle HCM Cloud.
• ProtocolParams: string (byte)
  Base64-encoded JSON object for parameters required to access the service.

{
    "type":"object",
    "properties":{
        "Protocol":{
            "maxLength":80,
            "type":"string",
            "description":"Text that identifies the service type. Developers should use the value TrackingServicesBridge for external systems that transfer data from fitness tracking services to Oracle HCM Cloud.",
            "nullable":false,
            "x-queryable":false
        },
        "ProtocolParams":{
            "type":"string",
            "description":"Base64-encoded JSON object for parameters required to access the service.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "authArtifacts":{
            "title":"Authorization Artifacts",
            "type":"array",
            "description":"The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.",
            "items":{
                "$ref":"#/components/schemas/trackingServices-authArtifacts-item-patch-request"
            }
        }
    }
}

Nested Schema : Authorization Artifacts

Type: array

Title: Authorization Artifacts

The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.

Show Source

• Array of: object trackingServices-authArtifacts-item-patch-request

{
    "title":"Authorization Artifacts",
    "type":"array",
    "description":"The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.",
    "items":{
        "$ref":"#/components/schemas/trackingServices-authArtifacts-item-patch-request"
    }
}

Nested Schema : trackingServices-authArtifacts-item-patch-request

Type: object

Show Source

• Artifacts: string (byte)
  Base64-encoded JSON object for parameters used to access the service as an authorized user.

{
    "type":"object",
    "properties":{
        "Artifacts":{
            "type":"string",
            "description":"Base64-encoded JSON object for parameters used to access the service as an authorized user.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        }
    }
}

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

Type: object

Show Source

• authArtifacts: array Authorization Artifacts
  Title: Authorization Artifacts

  The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.
• DisplayName: string
  Maximum Length: 80

  Name of the tracking service. Must be unique.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Protocol: string
  Maximum Length: 80

  Text that identifies the service type. Developers should use the value TrackingServicesBridge for external systems that transfer data from fitness tracking services to Oracle HCM Cloud.
• ProtocolParams: string (byte)
  Base64-encoded JSON object for parameters required to access the service.
• State: string
  Maximum Length: 80

  State of the tracking service. Currently, only ORA_ENABLED is supported.
• TrackingServiceId: integer
  Unique identifier for the tracking service.
• Vendor: string
  Maximum Length: 80

  Name of the provider of the tracking service.

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the tracking service. Must be unique.",
            "nullable":false,
            "x-queryable":true
        },
        "Protocol":{
            "maxLength":80,
            "type":"string",
            "description":"Text that identifies the service type. Developers should use the value TrackingServicesBridge for external systems that transfer data from fitness tracking services to Oracle HCM Cloud.",
            "nullable":false,
            "x-queryable":false
        },
        "ProtocolParams":{
            "type":"string",
            "description":"Base64-encoded JSON object for parameters required to access the service.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "State":{
            "maxLength":80,
            "type":"string",
            "description":"State of the tracking service. Currently, only ORA_ENABLED is supported.",
            "nullable":false,
            "x-queryable":false
        },
        "TrackingServiceId":{
            "type":"integer",
            "description":"Unique identifier for the tracking service.",
            "nullable":false,
            "x-queryable":true
        },
        "Vendor":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the provider of the tracking service.",
            "nullable":true,
            "x-queryable":false
        },
        "authArtifacts":{
            "title":"Authorization Artifacts",
            "type":"array",
            "description":"The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.",
            "items":{
                "$ref":"#/components/schemas/trackingServices-authArtifacts-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Authorization Artifacts

Type: array

Title: Authorization Artifacts

The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.

Show Source

• Array of: object trackingServices-authArtifacts-item-response

{
    "title":"Authorization Artifacts",
    "type":"array",
    "description":"The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.",
    "items":{
        "$ref":"#/components/schemas/trackingServices-authArtifacts-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 : trackingServices-authArtifacts-item-response

Type: object

Show Source

• Artifacts: string (byte)
  Base64-encoded JSON object for parameters used to access the service as an authorized user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TrackingServiceId: integer
  Unique identifier for the tracking service.
• UserId: string
  Maximum Length: 80

  User ID for the authentication information.

{
    "type":"object",
    "properties":{
        "Artifacts":{
            "type":"string",
            "description":"Base64-encoded JSON object for parameters used to access the service as an authorized user.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "TrackingServiceId":{
            "type":"integer",
            "description":"Unique identifier for the tracking service.",
            "nullable":false,
            "x-queryable":false
        },
        "UserId":{
            "maxLength":80,
            "type":"string",
            "description":"User ID for the authentication information.",
            "nullable":false,
            "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."
        }
    }
}

Links

authArtifacts

Operation: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts

Parameters:

• DisplayName: $request.path.DisplayName

The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.

Back to Top