Jump to

• Request
• Response
• Examples

Return the Apiary project

get

/developers/services/v1/apis/{apiId}/iterations/{iterId}/apiary

Returns the Apiary project for the given iteration.

Request

Path Parameters

• apiId: string
  A unique ID referencing a specific API.
• iterId: string
  A unique ID referencing a specific iteration of an API.

Back to Top

Response

200 Response

The Apiary project

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to retrieve the details of the Apiary API project configured  for the {iterId} iteration of the {apiId} API by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-u apicsadmin:password
https://example.com:443/developers/services/v1/apis/{apiId}/iterations/{iterId}/apiary

• {apiid} is the unique ID for an API. To retrieve available plan IDs, see Get APIs.

• {iterId} is the unique ID of the iteration.

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle Traffic Director
Date: Wed, 20 Dec 2017 05:19:46 GMT
Content-type: application/json
X-oracle-dms-ecid: 6^3rv0_eR00000000
X-oracle-dms-rid: 0:1

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
      "visibility": "public",
      "gitHubConnected": false,
      "_links": {
          "add": {
              "href": 
  "https://example.apiary.io/api-projects/5888e533f82a9c1f00b0b03d/add"
          },
          "owner": {
              "href": 
  "https://example.apiary.io/users/57599a5f5a4e710b004533e8"
          },
          "mockUrl": {
              "href": 
  "http://private-energy23.apiary-mock.com/"
          },
          "htmlEdit": {
              "href": "https://app.apiary.io/energy23/editor"
          },
          "self": {
              "href": 
  "https://example.apiary.io/api-projects/5888e533f82a9c1f00b0b03d"
          },
          "ap": {
              "href": "https://energy23.docs.apiary.io/"
          }
      },
      "_embedded": {
          "embedCode": {
              "scriptCode": "var embed = new Apiary.Embed({uuid: 
  '5888e533f82a9c1f00b0b03d', token:  '{your token})",
              "src": "https://api.apiary.io/seeds/embed.js",
              "token": "{your token} "
          },
          "version": {
              "lastUpdated": "2017-01-25T17:49:48.274Z",
              "_links": {
                  "add": {
                      "href": 
  "https://example.apiary.io/api-projects/version/5888e53ca6e17c1f0072d230/add"
                  },
                  "self": {
                      "href": 
  "https://example.apiary.io/api-projects/version/5888e53ca6e17c1f0072d230"
                  }
              },
              "author": {
                  "name": "API Developer",
                  "source": "apiary"
              },
              "uuid": "5888e53ca6e17c1f0072d230"
          }
      },
      "name": "Gas and Electricity Usage",
      "subdomain": "energy23",
      "type": "swagger",
      "uuid": "5888e533f82a9c1f00b0b03d"
  }

Back to Top