1. REST APIs for Oracle Health Clinical Data ExchangeREST APIs for Oracle Health Clinical Data Exchange
  2. Quick Start
  3. Quick Start for Oracle Health Clinical Data Exchange APIs

Quick Start for Oracle Health Clinical Data Exchange APIs

Complete these tasks to set up your environment and use the proprietary REST APIs for Oracle Health Clinical Data Exchange.

Prerequisites

Prerequisite More Information
Install cURL Use cURL
Set up authentication Authenticate with an Oracle Cloud Infrastructure signature
Sign in to Oracle Health Clinical Data Exchange This documentation assumes that you have an Oracle Health Clinical Data Exchange account.

Cancel work requests

For more information, see Cancel work requests.

Issue the following cURL command:

curl -v -X DELETE -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/workRequests/<work_request_ID> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <work_request_ID> is the unique ID for the work request, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An HTTP 204 message displays, indicating that the system has deleted the content.

Create a DeliveryEndpoint

For more information, see Create a DeliveryEndpoint.

Issue the following cURL command:

curl -v -X POST -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/deliveryEndpoints -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\"" -d '<input_json>'

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

  • <input_json> is the JSON object to be passed. For example: 

    {
    "payerId": "ocid1.cdexhubpayer.oc1.<region>.<UNIQUE_ID>",
    "compartmentId": "ocid1.compartment.oc1..<UNIQUE_ID>",
    "displayName": "Delivery endpoint 1",
    "description": "Used for pushing ADT messages to customer endpoint",
    "messageType": "ADT",
    "adtEventType": [
        "ADT-A01",
        "ADT-A08"
    ],
    "url": "<payer ADT delivery endpoint>",
    "caBundleId": "ocid1.cabundle.oc1.<region>.<UNIQUE_ID>",
    "freeformTags" : { "my-key": "Test delivery endpoint ..."}
}

An HTTP 201 message displays, indicating your request was successful.

Create a QueryEndpoint

For more information, see Create a QueryEndpoint.

Issue the following cURL command:

curl -v -X POST -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/queryEndpoints -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\"" -d '<input_json>'

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

  • <input_json> is the JSON object to be passed. For example: 

    {
    "payerId": "ocid1.cdexhubpayer.oc1.iad.<UNIQUE_ID>",
    "displayName": "Query endpoint 1",
    "description": "Used for getting medical information via FHIR interface",
    "compartmentId": "ocid1.compartment.oc1..<UNIQUE_ID>",
    "framework": "FHIR",
    "identityDomainUrl": "https://idcs.<UNIQUE_ID>.us-chicago-1.oraclecloud.com",
    "clientAppDetails": {
        "audience": "audience123"
    },
    "freeformTags" : { "my-key": "test query endpoint ..."}
}

An HTTP 201 message displays, indicating your request was successful.

Delete a DeliveryEndpoint

For more information, see Delete a DeliveryEndpoint.

Issue the following cURL command:

curl -v -X DELETE -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/deliveryEndpoints/<delivery_endpoint_ID> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <delivery_endpoint_ID> is the unique ID for the delivery endpoint, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An HTTP 204 message displays, indicating that the system has deleted the content.

Delete a QueryEndpoint

For more information, see Delete a QueryEndpoint.

Issue the following cURL command:

curl -v -X DELETE -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/queryEndpoints/<query_endpoint_ID> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_endpoint_ID> is the unique ID for the query endpoint, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An HTTP 204 message displays, indicating that the system has deleted the content.

Get a DeliveryEndpoint

For more information, see Get a DeliveryEndpoint.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/deliveryEndpoints/<delivery_endpoint_ID> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <delivery_endpoint_ID> is the unique ID for the delivery endpoint, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "id": "string",
  "payerId": "string",
  "url": "string",
  "messageType": "ADT",
  "adtEventType": [
    "string"
  ],
  "displayName": "string",
  "description": "string",
  "compartmentId": "string",
  "caBundleId": "string",
  "timeCreated": "2024-09-11T14:06:24.004Z",
  "timeUpdated": "2024-09-11T14:06:24.004Z",
  "lifecycleState": "CREATING",
  "lifecycleDetails": "string",
  "freeformTags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "definedTags": {
    "additionalProp1": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp2": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp3": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    }
  },
  "systemTags": {
    "additionalProp1": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp2": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp3": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    }
  }
}

Get a list of DataSharingAgreements

For more information, see Get a list of DataSharingAgreements.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/dataSharingAgreements?<query_parameters> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_parameters> are the query parameters for the request
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "items": [
    {
      "id": "string",
      "payerId": "string",
      "providerId": "string",
      "displayName": "string",
      "compartmentId": "string",
      "payerIdentifiers": [
        "string"
      ],
      "timeCreated": "2024-09-11T14:08:42.566Z",
      "timeUpdated": "2024-09-11T14:08:42.566Z",
      "lifecycleState": "string",
      "lifecycleDetails": "string",
      "freeformTags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "definedTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      },
      "systemTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      }
    }
  ]
}

Get a list of DataSharingConstraints

For more information, see Get a list of DataSharingConstraints.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/dataSharingConstraints?<query_parameters> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_parameters> are the query parameters for the request
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "items": [
    {
      "id": "string",
      "dataSharingAgreementId": "string",
      "constraints": {
        "additionalProp1": true,
        "additionalProp2": true,
        "additionalProp3": true
      },
      "displayName": "string",
      "compartmentId": "string",
      "timeCreated": "2024-09-11T14:12:57.481Z",
      "timeUpdated": "2024-09-11T14:12:57.481Z",
      "lifecycleState": "string",
      "lifecycleDetails": "string",
      "freeformTags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "definedTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      },
      "systemTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      }
    }
  ]
}

Get a list of DeliveryEndpoints

For more information, see Get a list of DeliveryEndpoints.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/deliveryEndpoints?<query_parameters> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_parameters> are the query parameters for the request
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "items": [
    {
      "id": "string",
      "payerId": "string",
      "url": "string",
      "messageType": "string",
      "adtEventType": [
        "string"
      ],
      "displayName": "string",
      "description": "string",
      "compartmentId": "string",
      "caBundleId": "string",
      "timeCreated": "2024-09-11T14:16:44.472Z",
      "timeUpdated": "2024-09-11T14:16:44.472Z",
      "lifecycleState": "string",
      "lifecycleDetails": "string",
      "freeformTags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "definedTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      },
      "systemTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      }
    }
  ]
}

Get a list of PayerDirectoryEntries

For more information, see Get a list of PayerDirectoryEntries.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/payerDirectoryEntries?<query_parameters> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_parameters> are the query parameters for the request
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "items": [
    {
      "id": "string",
      "payerId": "string",
      "directoryEntry": {
        "streetAddress": "12345 Foo Street\n",
        "secondaryAddressLine": "string",
        "city": "string",
        "district": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string",
        "phone": "string",
        "fax": "string",
        "sms": "string",
        "email": "string",
        "alternateContactMethods": [
          {
            "method": "string",
            "address": "string"
          }
        ]
      },
      "displayName": "string",
      "compartmentId": "string",
      "timeCreated": "2024-09-11T14:17:55.793Z",
      "timeUpdated": "2024-09-11T14:17:55.793Z",
      "lifecycleState": "string",
      "lifecycleDetails": "string",
      "freeformTags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "definedTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      },
      "systemTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      }
    }
  ]
}

Get a list of Payers

For more information, see Get a list of Payers.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/payers?<query_parameters> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_parameters> are the query parameters for the request
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "items": [
    {
      "id": "string",
      "displayName": "string",
      "description": "string",
      "payerTenancyId": "string",
      "compartmentId": "string",
      "timeCreated": "2024-09-11T15:31:01.452Z",
      "timeUpdated": "2024-09-11T15:31:01.452Z",
      "lifecycleState": "string",
      "lifecycleDetails": "string",
      "freeformTags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "definedTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      },
      "systemTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      }
    }
  ]
}

Get a list of ProviderDirectoryEntries

For more information, see Get a list of ProviderDirectoryEntries.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/providerDirectoryEntries?<query_parameters> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_parameters> are the query parameters for the request
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "items": [
    {
      "id": "string",
      "providerId": "string",
      "directoryEntry": {
        "streetAddress": "12345 Foo Street\n",
        "secondaryAddressLine": "string",
        "city": "string",
        "district": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string",
        "phone": "string",
        "fax": "string",
        "sms": "string",
        "email": "string",
        "alternateContactMethods": [
          {
            "method": "string",
            "address": "string"
          }
        ]
      },
      "displayName": "string",
      "compartmentId": "string",
      "timeCreated": "2024-09-11T15:43:58.985Z",
      "timeUpdated": "2024-09-11T15:43:58.985Z",
      "lifecycleState": "string",
      "lifecycleDetails": "string",
      "freeformTags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "definedTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      },
      "systemTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      }
    }
  ]
}

Get a list of QueryEndpoints

For more information, see Get a list of QueryEndpoints.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/queryEndpoints?<query_parameters> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_parameters> are the query parameters for the request
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "items": [
    {
      "id": "string",
      "payerId": "string",
      "url": "string",
      "framework": "string",
      "identityDomainUrl": "string",
      "displayName": "string",
      "description": "string",
      "compartmentId": "string",
      "timeCreated": "2024-09-11T15:45:42.267Z",
      "timeUpdated": "2024-09-11T15:45:42.267Z",
      "lifecycleState": "string",
      "lifecycleDetails": "string",
      "clientAppDetails": {
        "clientId": "string"
      },
      "freeformTags": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "definedTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      },
      "systemTags": {
        "additionalProp1": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp2": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "additionalProp3": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      }
    }
  ]
}

Get a Payer

For more information, see Get a Payer.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/payers/<payer_ID> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <payer_ID> is the unique ID for the payer, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "id": "string",
  "displayName": "string",
  "description": "string",
  "compartmentId": "string",
  "payerTenancyId": "string",
  "cellId": "string",
  "timeCreated": "2024-09-11T15:48:04.053Z",
  "timeUpdated": "2024-09-11T15:48:04.053Z",
  "lifecycleState": "CREATING",
  "lifecycleDetails": "string",
  "freeformTags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "definedTags": {
    "additionalProp1": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp2": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp3": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    }
  },
  "systemTags": {
    "additionalProp1": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp2": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp3": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    }
  }
}

Get a PayerDirectoryEntry

For more information, see Get a PayerDirectoryEntry.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/payerDirectoryEntries/<payer_directory_entry_ID> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <payer_directory_entry_ID> is the unique ID for the payer directory entry, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "id": "string",
  "payerId": "string",
  "directoryEntry": {
    "streetAddress": "12345 Foo Street\n",
    "secondaryAddressLine": "string",
    "city": "string",
    "district": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "phone": "string",
    "fax": "string",
    "sms": "string",
    "email": "string",
    "alternateContactMethods": [
      {
        "method": "string",
        "address": "string"
      }
    ]
  },
  "displayName": "string",
  "compartmentId": "string",
  "timeCreated": "2024-09-11T15:54:44.147Z",
  "timeUpdated": "2024-09-11T15:54:44.147Z",
  "lifecycleState": "ACTIVE",
  "lifecycleDetails": "string",
  "freeformTags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "definedTags": {
    "additionalProp1": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp2": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp3": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    }
  },
  "systemTags": {
    "additionalProp1": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp2": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp3": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    }
  }
}

Get a QueryEndpoint

For more information, see Get a QueryEndpoint.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/queryEndpoints/<query_endpoint_ID> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_endpoint_ID> is the unique ID for the query endpoint, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "id": "string",
  "payerId": "string",
  "url": "string",
  "framework": "FHIR",
  "identityDomainUrl": "string",
  "displayName": "string",
  "description": "string",
  "compartmentId": "string",
  "timeCreated": "2024-09-11T15:55:32.298Z",
  "timeUpdated": "2024-09-11T15:55:32.298Z",
  "lifecycleState": "CREATING",
  "lifecycleDetails": "string",
  "clientAppDetails": {
    "clientId": "string"
  },
  "freeformTags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "definedTags": {
    "additionalProp1": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp2": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp3": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    }
  },
  "systemTags": {
    "additionalProp1": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp2": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "additionalProp3": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    }
  }
}

Get work request status

For more information, see Get work request status.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/workRequests/<workRequestId> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <work_request_ID> is the unique ID for the work request, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "operationType": "CREATE_DATA_SHARING_AGREEMENT",
  "status": "ACCEPTED",
  "id": "string",
  "compartmentId": "string",
  "resources": [
    {
      "entityType": "string",
      "actionType": "CREATED",
      "identifier": "string",
      "entityUri": "string",
      "metadata": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "percentComplete": 0,
  "timeAccepted": "2024-09-11T16:00:03.593Z",
  "timeStarted": "2024-09-11T16:00:03.593Z",
  "timeFinished": "2024-09-11T16:00:03.593Z",
  "timeUpdated": "2024-09-11T16:00:03.593Z"
}

List work request errors

For more information, see List work request errors.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/workRequests/<workRequestId>/errors?<query_parameters> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <work_request_ID> is the unique ID for the work request, in alphanumeric format
  • <query_parameters> are the query parameters for the request
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "items": [
    {
      "code": "string",
      "message": "string",
      "timestamp": "2024-09-11T16:01:59.059Z"
    }
  ]
}

List work request logs

For more information, see List work request logs.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/workRequests/<workRequestId>/logs?<query_parameters> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <work_request_ID> is the unique ID for the work request, in alphanumeric format
  • <query_parameters> are the query parameters for the request
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "items": [
    {
      "message": "string",
      "timestamp": "2024-09-11T16:03:30.100Z"
    }
  ]
}

List work requests

For more information, see List work requests.

Issue the following cURL command:

curl -v -X GET -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/workRequests?<query_parameters> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\""

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_parameters> are the query parameters for the request
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

An example of the HTTP 200 output is as follows:

{
  "items": [
    {
      "operationType": "CREATE_DATA_SHARING_AGREEMENT",
      "status": "ACCEPTED",
      "id": "string",
      "compartmentId": "string",
      "resources": [
        {
          "entityType": "string",
          "actionType": "CREATED",
          "identifier": "string",
          "entityUri": "string",
          "metadata": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      ],
      "percentComplete": 0,
      "timeAccepted": "2024-09-11T16:06:21.208Z",
      "timeStarted": "2024-09-11T16:06:21.208Z",
      "timeFinished": "2024-09-11T16:06:21.208Z",
      "timeUpdated": "2024-09-11T16:06:21.208Z"
    }
  ]
}

Move the DeliveryEndpoint into a different compartment

For more information, see Move the DeliveryEndpoint into a different compartment.

Issue the following cURL command:

curl -v -X POST -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/deliveryEndpoints/<delivery_endpoint_ID>/actions/changeCompartment -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\"" -d '<input_json>'

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <delivery_endpoint_ID> is the unique ID for the delivery endpoint, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

  • <input_json> is the JSON object to be passed. For example: 

    {
    "compartmentId": "ocid1.compartment.oc1..<UNIQUE_ID>"
}

An HTTP 202 message displays, indicating your request was successful.

Move the QueryEndpoint into a different compartment

For more information, see Move the QueryEndpoint into a different compartment.

Issue the following cURL command:

curl -v -X POST -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/queryEndpoints/<query_endpoint_ID>/actions/changeCompartment -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\"" -d '<input_json>'

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <delivery_endpoint_ID> is the unique ID for the delivery endpoint, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

  • <input_json> is the JSON object to be passed. For example: 

    {
    "compartmentId": "ocid1.compartment.oc1..<UNIQUE_ID>"
}

An HTTP 202 message displays, indicating your request was successful.

Test DeliveryEndpoint connectivity

For more information, see Test DeliveryEndpoint connectivity.

Issue the following cURL command:

curl -v -X POST -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/deliveryEndpoints/<delivery_endpoint_ID>/actions/testConnectivity -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\"" -d '<input_json>'

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <delivery_endpoint_ID> is the unique ID for the delivery endpoint, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

  • <input_json> is the JSON object to be passed. For example: 

    {

}

An HTTP 202 message displays, indicating your request was successful.

Update a DeliveryEndpoint

For more information, see Update a DeliveryEndpoint.

Issue the following cURL command:

curl -v -X PUT -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/deliveryEndpoints/<delivery_endpoint_ID> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\"" -d '<input_json>'

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <delivery_endpoint_ID> is the unique ID for the delivery endpoint, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

  • <input_json> is the JSON object to be passed. For example: 

    {
    "displayName": "Update delivery endpoint display name",
    "description": "Update delivery endpoint description"
}

An HTTP 202 message displays, indicating your request was successful.

Update a PayerDirectoryEntry

For more information, see Update a PayerDirectoryEntry.

Issue the following cURL command:

curl -v -X PUT -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/payerDirectoryEntries/<payer_directory_entry_ID> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\"" -d '<input_json>'

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <payer_directory_entry_ID> is the unique ID for the payer directory entry, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

  • <input_json> is the JSON object to be passed. For example: 

    {
    "displayName": "Update payer display name",
    "directoryEntry": {
        "streetAddress": "Payer street address ...",
        "city": "<City>",
        "state": "<State>",
        "postalCode": "<zip code>",
        "phone": "<phone number>",
        "fax": "<fax number>",
        "email": "<email address>"
    }
}

An HTTP 200 message displays, indicating your request was successful.

Update a QueryEndpoint

For more information, see Update a QueryEndpoint.

Issue the following cURL command:

curl -v -X PUT -sS https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/queryEndpoints/<query_endpoint_ID> -H "date: <date>" -H "Authorization: Signature version=\"1\",keyId=\"<keyId>\",algorithm=\"rsa-sha256\",headers=\"(request-target) date host\",signature=\"<signature>\"" -d '<input_json>'

Where:

  • <cloud_region> is the Oracle Cloud Infrastructure region for your tenancy (for example, us-chicago-1)
  • <query_endpoint_ID> is the unique ID for the query endpoint, in alphanumeric format
  • <date> is the date in GMT format (YYYY-DD-MM)

  • <keyId> is the authorization key that contains the <Tenancy-OCID>/<User-OCID>/<API-Key-FingerPrint>, as follows:

    • <Tenancy-OCID> is the unique ID for the Oracle Cloud Infrastructure tenancy
    • <User-OCID> is the unique ID for the user that belongs to the Oracle Cloud Infrastructure tenancy
    • <API-Key-FingerPrint> is the unique ID for the API key FingerPrint
  • <signature> is the signature that contains all the headers in the request

  • <input_json> is the JSON object to be passed. For example: 

    {
    "displayName": "Update query endpoint display name",
    "description": "Update query endpoint description"
}

An HTTP 202 message displays, indicating your request was successful.

Browse the APIs

The main left-side navigation of the API documentation is organized around tasks. If you prefer to browse the API endpoints in a different order:

  • Select All REST Endpoints under Introduction.
  • Choose one of the Sort by options at the top of the page.