Jump to

• Request
• Response

Create a tracking service

post

/hcmRestApi/resources/11.13.18.05/trackingServices

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

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.
• DisplayName(required): string
  Maximum Length: 80

  Name of the tracking service. Must be unique.
• Protocol(required): 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(required): string (byte)
  Base64-encoded JSON object for parameters required to access the service.
• State(required): 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.

{
    "required":[
        "DisplayName",
        "Protocol",
        "ProtocolParams",
        "State"
    ],
    "type":"object",
    "properties":{
        "TrackingServiceId":{
            "type":"integer",
            "description":"Unique identifier for the tracking service.",
            "nullable":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-post-request"
            }
        },
        "State":{
            "maxLength":80,
            "type":"string",
            "description":"State of the tracking service. Currently, only ORA_ENABLED is supported.",
            "nullable":false,
            "x-queryable":false
        },
        "DisplayName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the tracking service. Must be unique.",
            "nullable":false
        },
        "Vendor":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the provider of the tracking service.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        }
    }
}

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-post-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-post-request"
    }
}

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

Type: object

Show Source

• Artifacts: string (byte)
  Base64-encoded JSON object for parameters used to access the service as an authorized user.
• 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
        }
    }
}

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":{
        "TrackingServiceId":{
            "type":"integer",
            "description":"Unique identifier for the tracking service.",
            "nullable":false,
            "x-queryable":true
        },
        "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"
            }
        },
        "State":{
            "maxLength":80,
            "type":"string",
            "description":"State of the tracking service. Currently, only ORA_ENABLED is supported.",
            "nullable":false,
            "x-queryable":false
        },
        "DisplayName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the tracking service. Must be unique.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Vendor":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the provider of the tracking service.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        }
    }
}

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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        }
    }
}

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