Jump to

• Request
• Response

Get a DeliveryEndpoint

get

/20180828/deliveryEndpoints/{deliveryEndpointId}

This path retrieves information about a DeliveryEndpoint.

Request

Path Parameters

• deliveryEndpointId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DeliveryEndpoint.

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The DeliveryEndpoint was retrieved.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : DeliveryEndpoint

Type: object

A DeliveryEndpoint specifies how and where to deliver data of a particular type to a payer, and the information that is necessary to authenticate with the receiver.

Show Source

• adtEventType: array adtEventType
  Maximum Number of Items: 512

  The type or types of admission, discharge, transfer (ADT) events to deliver to this endpoint, for example, ADT01 or ADT08.
• caBundleId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the delivery endpoint CA bundle.
• compartmentId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
• description: string
  A detailed description of the delivery endpoint. This description can be changed.
• displayName: string
  A user-friendly name. This name does not have to be unique, and it can be changed.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
• id(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DeliveryEndpoint.
• lifecycleDetails: string
  A message that describes the current state of the DeliveryEndpoint in more detail. For example, this message can be used to provide actionable information for a resource in a Failed state.
• lifecycleState(required): string
  Allowed Values: [ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]

  The current state of the DeliveryEndpoint.
• messageType(required): string
  Allowed Values: [ "ADT" ]

  The type of message to deliver to the payer at this endpoint.
• oauth2Info(required): object DeliveryEndpointOauth2Info
  The OAuth 2.0 information that is used by a delivery endpoint.
• payerId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the payer who uses this endpoint.
• requestHeaders(required): object requestHeaders
  Minimum Number of Properties: 1

  Maximum Number of Properties: 50

  Additional Properties Allowed: additionalProperties

  The request headers (that is, the key-value pairs) that the delivery endpoint requires.
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
• timeCreated(required): string(date-time)
  The date and time that the DeliveryEndpoint was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). For example, `2016-08-25T21:10:29.600Z`
• timeUpdated: string(date-time)
  The date and time that the DeliveryEndpoint was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). For example, `2016-08-25T21:10:29.600Z`
• url(required): string
  A fully-formed https URL to which the system sends data.

{
    "description":"A DeliveryEndpoint specifies how and where to deliver data of a particular type to a payer, and the information that is necessary\nto authenticate with the receiver.\n",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"deliveryEndpoint",
        "ocidEntityType":"cdexhubdeliveryendpoint",
        "adLocality":"regional",
        "activeLifecycleStates":[
            "ACTIVE"
        ],
        "deletedLifecycleStates":[
            "DELETED"
        ],
        "getOperationId":"GetDeliveryEndpoint",
        "listResourcesOperationId":"ListDeliveryEndpoints",
        "searchMetadata":{
            "resourceSchemaVersion":"1",
            "resourceType":"DeliveryEndpoint",
            "scope":"${rqs_scope}"
        },
        "workRequestDetails":{
            "workRequestEntityType":"cdexhubworkrequest",
            "workRequestGetOperationId":"GetWorkRequest",
            "successfulLifecycleStates":[
                "SUCCEEDED"
            ],
            "failedLifecycleStates":[
                "FAILED",
                "CANCELED"
            ]
        }
    },
    "required":[
        "id",
        "payerId",
        "url",
        "messageType",
        "compartmentId",
        "caBundleId",
        "oauth2Info",
        "requestHeaders",
        "lifecycleState",
        "timeCreated"
    ],
    "properties":{
        "id":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DeliveryEndpoint.",
            "type":"string"
        },
        "payerId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the payer who uses this endpoint.",
            "type":"string"
        },
        "url":{
            "description":"A fully-formed https URL to which the system sends data.",
            "type":"string"
        },
        "messageType":{
            "description":"The type of message to deliver to the payer at this endpoint.",
            "type":"string",
            "enum":[
                "ADT"
            ]
        },
        "adtEventType":{
            "description":"The type or types of admission, discharge, transfer (ADT) events to deliver to this endpoint, for example, ADT01 or ADT08.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "maxItems":"512"
        },
        "displayName":{
            "description":"A user-friendly name. This name does not have to be unique, and it can be changed.",
            "type":"string"
        },
        "description":{
            "description":"A detailed description of the delivery endpoint. This description can be changed.",
            "type":"string"
        },
        "compartmentId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
            "type":"string"
        },
        "caBundleId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the delivery endpoint CA bundle.",
            "type":"string"
        },
        "oauth2Info":{
            "$ref":"#/definitions/DeliveryEndpointOauth2Info"
        },
        "requestHeaders":{
            "type":"object",
            "description":"The request headers (that is, the key-value pairs) that the delivery endpoint requires.",
            "additionalProperties":{
                "type":"string"
            },
            "minProperties":"1",
            "maxProperties":"50"
        },
        "timeCreated":{
            "description":"The date and time that the DeliveryEndpoint was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nFor example, `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The date and time that the DeliveryEndpoint was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nFor example, `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "lifecycleState":{
            "description":"The current state of the DeliveryEndpoint.",
            "type":"string",
            "enum":[
                "CREATING",
                "UPDATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ]
        },
        "lifecycleDetails":{
            "description":"A message that describes the current state of the DeliveryEndpoint in more detail. For example, this message\ncan be used to provide actionable information for a resource in a Failed state.\n",
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        },
        "systemTags":{
            "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        }
    }
}

Nested Schema : adtEventType

Type: array

Maximum Number of Items: 512

The type or types of admission, discharge, transfer (ADT) events to deliver to this endpoint, for example, ADT01 or ADT08.

Show Source

• Array of: string

{
    "description":"The type or types of admission, discharge, transfer (ADT) events to deliver to this endpoint, for example, ADT01 or ADT08.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "maxItems":"512"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`

Nested Schema : DeliveryEndpointOauth2Info

Type: object

The OAuth 2.0 information that is used by a delivery endpoint.

Show Source

• clientId(required): string
  The client identifier for OAuth 2.0 authentication.
• clientSecretId(required): string
  The OCID for the secret that is associated with the client identifier.
• grantType(required): string
  Default Value: CLIENT_CREDENTIALS

  Allowed Values: [ "CLIENT_CREDENTIALS" ]

  The OAuth 2.0 grant type that is to be used.
• scope(required): string
  The scopes of the OAuth 2.0 authorization. The scopes are displayed as comma-separated values.
• tokenUri(required): string
  The URI that is used to request the OAuth 2.0 token.

{
    "description":"The OAuth 2.0 information that is used by a delivery endpoint.",
    "type":"object",
    "required":[
        "clientId",
        "clientSecretId",
        "tokenUri",
        "grantType",
        "scope"
    ],
    "properties":{
        "clientId":{
            "type":"string",
            "description":"The client identifier for OAuth 2.0 authentication."
        },
        "clientSecretId":{
            "type":"string",
            "description":"The OCID for the secret that is associated with the client identifier."
        },
        "tokenUri":{
            "type":"string",
            "description":"The URI that is used to request the OAuth 2.0 token."
        },
        "grantType":{
            "type":"string",
            "enum":[
                "CLIENT_CREDENTIALS"
            ],
            "default":"CLIENT_CREDENTIALS",
            "description":"The OAuth 2.0 grant type that is to be used."
        },
        "scope":{
            "type":"string",
            "description":"The scopes of the OAuth 2.0 authorization. The scopes are displayed as comma-separated values."
        }
    }
}

Nested Schema : requestHeaders

Type: object

Minimum Number of Properties: 1

Maximum Number of Properties: 50

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"The request headers (that is, the key-value pairs) that the delivery endpoint requires.",
    "additionalProperties":{
        "type":"string"
    },
    "minProperties":"1",
    "maxProperties":"50"
}

The request headers (that is, the key-value pairs) that the delivery endpoint requires.

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

{
    "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique identifier for the request

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top