Retrieve Project Details

GET 
/org/:orgId/project/:projectId

Reads the project identified by projectId in the endpoint and returns the JSON representations.

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

projectId stringrequired

The Project ID (UUID) for which you are querying.

Responses

200

Success.

application/json

Schema

Schema

id string
name string
description string
version integer
created integer
createdBy string

Example (from schema)

{
  "id": "4e3280de-98bc-46d3-4079-e8eef5449b36",
  "name": "Clickstream Analytics",
  "properties": {
    "aggregate-prediction": null,
    "caption": "Clickstream Analytics",
    "visible": true
  },
  "version": 15,
  "annotations": {
    "annotation": [
      {
        "name": "version",
        "value": "6"
      },
      {
        "name": "engineId",
        "value": "omniture"
      },
      {
        "name": "versionTag",
        "value": "Published on Mar 21, 2017 at 9:52am (PDT)"
      }
    ]
  },
  "attributes": {
    "attribute-key": [
      {
        "id": "b267221c-ee91-49bf-933f-d21c08e7d91b",
        "properties": {
          "visible": true
        }
      }
    ],
    "keyed-attribute": [
      {
        "id": "c28e2ef9-0522-4dbf-508d-d80b5f93df68",
        "key-ref": "b267221c-ee91-49bf-933f-d21c08e7d91b",
        "name": "country",
        "properties": {
          "caption": "Country",
          "type": {
            "enum": {}
          },
          "visible": true
        }
      }
    ]
  }
}

401

This error will occur if calling user does not have access right for the API.

503

This error will occur if Design Center APIs are not enabled.

Loading...