Jump to

• Request
• Response

Get a specific configuration of a project.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/configurations/{key}

This operation returns the specific configuration of a project. If the project configuration is not defined for that project, then organization configuration information having the same key is returned. If project and organization configuration are not defined for the key, global configuration information having the same key is returned.

Request

Path Parameters

• key: string
  Key that identifies configuration item
• orgId: string
  Organization identifier
• projectId: string
  Project identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Project configuration was successfully retrieved.

Body ()

Root Schema : Configuration

Type: object

Show Source

• key: string
  Key that identifies the configuration item

  Example: my.key
• links(optional): array links
  Read Only: true
• value: object value
  Value of the configuration item. Supported types are boolean, double, string, array of doubles and array of strings

{
    "required":[
        "key",
        "value"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that identifies the configuration item",
            "example":"my.key"
        },
        "value":{
            "type":"object",
            "description":"Value of the configuration item. Supported types are boolean, double, string, array of doubles and array of strings"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : value

Type: object

Value of the configuration item. Supported types are boolean, double, string, array of doubles and array of strings

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top