openapi: 3.2.0 info: description: Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the [Fusion Applications Environment Management documentation](/iaas/Content/fusion-applications/home.htm). title: Fusion Applications Environment Management Service Attachment API version: '20211201' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/2862e9b2d8df5c1b0fcbcce0eecb2a727ba22660b1a4afb08cc75980114cc127.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Fusion Applications Environment Management API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/2862e9b2d8df5c1b0fcbcce0eecb2a727ba22660b1a4afb08cc75980114cc127.yaml what: the harvested document for Fusion Applications Environment Management API servers: - url: http://127.0.0.1/20211201 - url: https://127.0.0.1/20211201 tags: - name: serviceAttachment paths: /fusionEnvironments/{fusionEnvironmentId}/serviceAttachments: get: description: 'Returns a list of service attachments. ' operationId: ListServiceAttachments parameters: - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ServiceAttachmentsLifecycleStateQueryParam' - $ref: '#/components/parameters/ServiceInstanceTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ServiceAttachmentSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ServiceAttachmentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all the service attachments to the fusion pod tags: - serviceAttachment x-related-resource: '#/definitions/ServiceAttachment' /fusionEnvironments/{fusionEnvironmentId}/serviceAttachments/{serviceAttachmentId}: get: description: Gets a Service Attachment by identifier operationId: GetServiceAttachment parameters: - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/ServiceAttachmentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the ServiceAttachment with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ServiceAttachment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get ServiceAttachment tags: - serviceAttachment components: responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' parameters: ServiceInstanceTypeQueryParam: description: A filter that returns all resources that match the specified lifecycle state. in: query name: serviceInstanceType required: false x-default-description: Returns all lifecycle states by default x-obmcs-enumref: '#/definitions/ServiceAttachment/serviceInstanceType' schema: type: string PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - TIME_CREATED - DISPLAY_NAME default: TIME_CREATED DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string ServiceAttachmentsLifecycleStateQueryParam: description: A filter that returns all resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: Returns all lifecycle states by default x-obmcs-enumref: '#/definitions/ServiceAttachment/lifecycleState' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 100 maximum: 100 minimum: 1 ServiceAttachmentIdentifierPathParam: description: OCID of the Service Attachment in: path name: serviceAttachmentId required: true schema: type: string FusionEnvironmentIdentifierPathParam: description: unique FusionEnvironment identifier in: path name: fusionEnvironmentId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder required: false schema: type: string enum: - ASC - DESC default: DESC schemas: ServiceAttachment: description: Description of ServiceAttachment. properties: action: description: Action type: string x-obmcs-enumref: '#/definitions/CreateServiceAttachmentDetails/action' compartmentId: description: Compartment Identifier maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Service Attachment Display name, can be renamed type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation type: string isSkuBased: description: Whether this service is provisioned due to the customer being subscribed to a specific SKU type: boolean lifecycleState: description: The current state of the ServiceInstance. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string serviceInstanceId: description: The ID of the service instance created that can be used to identify this on the service control plane type: string serviceInstanceType: description: Type of the serviceInstance. enum: - DIGITAL_ASSISTANT - INTEGRATION_CLOUD - ANALYTICS_WAREHOUSE - FUSION_DATA_INTELLIGENCE - VBCS - VISUAL_BUILDER_STUDIO type: string serviceUrl: description: Public URL type: string timeCreated: description: The time the the ServiceInstance was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the ServiceInstance was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - displayName - serviceInstanceType - lifecycleState - isSkuBased type: object ServiceAttachmentCollection: description: List of service attachments for a fusion instance. properties: items: description: A page of FusionEnvironmentFamilySummary objects. items: $ref: '#/components/schemas/ServiceAttachmentSummary' type: array required: - items type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message ServiceAttachmentSummary: description: Summary of the ServiceInstance. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: ServiceInstance Identifier, can be renamed type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation type: string isSkuBased: description: Whether this service is provisioned due to the customer being subscribed to a specific SKU type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the ServiceInstance. type: string x-obmcs-enumref: '#/definitions/ServiceAttachment/lifecycleState' serviceInstanceId: description: The ID of the service instance created that can be used to identify this on the service control plane type: string serviceInstanceType: description: Type of the service. type: string x-obmcs-enumref: '#/definitions/ServiceAttachment/serviceInstanceType' serviceUrl: description: Service URL of the instance type: string timeCreated: description: The time the service instance was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the serivce instance was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - displayName - serviceInstanceType - lifecycleState - isSkuBased type: object x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. format: float type: number x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: type: object type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.facontrolplane