Jump to

• Request
• Response

List Environments

get

/rpa/v1/environments

Gets a list of all available environments in service instance.

Request

Query Parameters

• displayName: string
  Minimum Length: 1

  Maximum Length: 50

  A filter to return only resources that match the entire display name given.
• isAvailableForEnvGroup: boolean
  Filters environments based on their avilability to be added int an envrionment group. False will not filter any environment. True will filter showing environments available for adding into a Environment Group.

  Default Value: false
• isForAutonomousEnvGroup: boolean
  To filter the environments

  Default Value: false
• lifecycleState: string
  A filter that returns all resources that match the specified lifecycle state.
• limit: integer
  Minimum Value: 1

  Maximum Value: 100

  The maximum number of items to return.

  Default Value: 100
• page: string
  Minimum Length: 1

  A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
• sortBy: string
  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.

  Default Value: TIME_CREATED

  Allowed Values: [ "TIME_CREATED", "DISPLAY_NAME", "ENVIRONMENT_GROUP_DISPLAY_NAME" ]
• sortOrder: string
  The sort order to use, either 'ASC' or 'DESC'.

  Allowed Values: [ "ASC", "DESC" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A page of Environment Summary objects.

Headers

• opc-next-page:
  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.
• opc-request-id:
  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 : EnvironmentCollection

Type: object

Results of a environment list operation. Contains EnvironmentSummary items.

Show Source

• items(required): array items
  List of EnvironmentSummary objects.

{
    "type":"object",
    "description":"Results of a environment list operation. Contains EnvironmentSummary items.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of EnvironmentSummary objects.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnvironmentSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of EnvironmentSummary objects.

Show Source

• Array of: object EnvironmentSummary
  Summary of an environment

{
    "description":"List of EnvironmentSummary objects.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EnvironmentSummary"
    }
}

Nested Schema : EnvironmentSummary

Type: object

Summary of an environment

Show Source

• agentVersion: string
  Minimum Length: 1

  Maximum Length: 50

  The agent version.
• createdBy: string
  Records the user who create the environment.
• description: string
  User given description of the environment.
• displayName(required): string
  User friendly display name for the environment.
• environmentGroupDisplayName(required): string
  The environment group display name if this environment is added to the environment group.
• environmentGroupIdentifier(required): string
  The environment group identifier if this environment is added to the environment group.
• environmentType: string
  The type of the environment.
• identifier(required): string
  Unique identifier that is immutable on creation.
• instanceMetadataProperties: object instanceMetadataProperties
  Additional Properties Allowed: additionalProperties

  Map for the instance Metadata System Properties
• keywords: string
  The keywords of the environment given by user.
• lifecycleState(required): string
  The current state of the environment.
• previousAgentVersion: string
  The previous agent version.
• projectId(required): string
  The environment group project Id if this environment is added to the environment group.
• systemProperties: object systemProperties
  Additional Properties Allowed: additionalProperties

  Map for the Environment System Properties
• timeAgentVersionUpdated: string (date-time)
  The time at which agent version was last updated.
• timeCreated: string (date-time)
  The time at which environment was created. An RFC3339 formatted datetime string.
• timeUpdated: string (date-time)
  The time at which environment was last updated. An RFC3339 formatted datetime string.
• updatedBy: string
  Records to user who last update the environment.

{
    "description":"Summary of an environment",
    "type":"object",
    "required":[
        "identifier",
        "displayName",
        "lifecycleState",
        "environmentGroupIdentifier",
        "environmentGroupDisplayName",
        "projectId"
    ],
    "properties":{
        "identifier":{
            "description":"Unique identifier that is immutable on creation.",
            "type":"string"
        },
        "displayName":{
            "description":"User friendly display name for the environment.",
            "type":"string"
        },
        "description":{
            "description":"User given description of the environment.",
            "type":"string"
        },
        "environmentGroupIdentifier":{
            "description":"The environment group identifier if this environment is added to the environment group.",
            "type":"string"
        },
        "environmentGroupDisplayName":{
            "description":"The environment group display name if this environment is added to the environment group.",
            "type":"string"
        },
        "projectId":{
            "description":"The environment group project Id if this environment is added to the environment group.",
            "type":"string"
        },
        "keywords":{
            "description":"The keywords of the environment given by user.",
            "type":"string"
        },
        "environmentType":{
            "description":"The type of the environment.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Environment/environmentType"
        },
        "agentVersion":{
            "description":"The agent version.",
            "type":"string",
            "minLength":1,
            "maxLength":50
        },
        "previousAgentVersion":{
            "description":"The previous agent version.",
            "type":"string"
        },
        "timeAgentVersionUpdated":{
            "description":"The time at which agent version was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"Records the user who create the environment.",
            "type":"string"
        },
        "updatedBy":{
            "description":"Records to user who last update the environment.",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the environment.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Environment/lifecycleState"
        },
        "timeCreated":{
            "description":"The time at which environment was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time at which environment was last updated. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "systemProperties":{
            "description":"Map<propName,value> for the Environment System Properties",
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "minLength":0,
                "maxLength":1024
            },
            "example":{
                "HostName":"JANEDOE-MACBOOKPRO",
                "OperatingSystemVersion":"12.6.5",
                "OperatingSystemName":"Mac OS X",
                "OperatingSystemArchitecture":"x86_64",
                "IPAddress":"10.0.1.3",
                "MacAddress":"F8-4D-89-87-F6-9D"
            }
        },
        "instanceMetadataProperties":{
            "description":"Map<propName,value> for the instance Metadata System Properties",
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "minLength":0,
                "maxLength":1024
            },
            "example":{
                "InstanceId":"ocid.instance",
                "InstancePoolId":"ocid.instancePool",
                "CompartmentId":"ocid.compartment",
                "Region":"us-ashburn-1"
            }
        }
    }
}

Nested Schema : instanceMetadataProperties

Type: object

Additional Properties Allowed

Show Source

• string
  Minimum Length: 0

  Maximum Length: 1024

{
    "description":"Map<propName,value> for the instance Metadata System Properties",
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "minLength":0,
        "maxLength":1024
    },
    "example":{
        "InstanceId":"ocid.instance",
        "InstancePoolId":"ocid.instancePool",
        "CompartmentId":"ocid.compartment",
        "Region":"us-ashburn-1"
    }
}

Map for the instance Metadata System Properties

Example:

{
    "InstanceId":"ocid.instance",
    "InstancePoolId":"ocid.instancePool",
    "CompartmentId":"ocid.compartment",
    "Region":"us-ashburn-1"
}

Nested Schema : systemProperties

Type: object

Additional Properties Allowed

Show Source

• string
  Minimum Length: 0

  Maximum Length: 1024

{
    "description":"Map<propName,value> for the Environment System Properties",
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "minLength":0,
        "maxLength":1024
    },
    "example":{
        "HostName":"JANEDOE-MACBOOKPRO",
        "OperatingSystemVersion":"12.6.5",
        "OperatingSystemName":"Mac OS X",
        "OperatingSystemArchitecture":"x86_64",
        "IPAddress":"10.0.1.3",
        "MacAddress":"F8-4D-89-87-F6-9D"
    }
}

Map for the Environment System Properties

Example:

{
    "HostName":"JANEDOE-MACBOOKPRO",
    "OperatingSystemVersion":"12.6.5",
    "OperatingSystemName":"Mac OS X",
    "OperatingSystemArchitecture":"x86_64",
    "IPAddress":"10.0.1.3",
    "MacAddress":"F8-4D-89-87-F6-9D"
}

400 Response

Bad Request

Headers

• opc-request-id:
  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 : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id:
  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 : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id:
  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 : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id:
  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 : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id:
  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 : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Default Response

Unknown Error

Headers

• opc-request-id:
  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 : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Back to Top