Jump to

• Request
• Response
• Examples

Retrieve Data Objects

get

/OracleBAMREST/api/projects/{projectname}/dataobjects

Retrieves list of data objects pertaining to a given Project.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Success

Body

Example Response (application/json)

{
    "items":[
        {
            "id":"/dataobject/CommonAudit_Error_DO",
            "name":"CommonAudit_Error_DO",
            "displayName":"/oracle/BAMProcess/CommonAudit_Error_DO",
            "links":[
                {
                    "rel":"self",
                    "href":"http://example.com:7001/OracleBAMREST/api/dataobjects/simpledataobjects/CommonAudit_Error_DO"
                }
            ]
        },
        {
            "id":"/dataobject/CommonAudit_DO",
            "name":"CommonAudit_DO",
            "displayName":"/oracle/BAMProcess/CommonAudit_DO",
            "links":[
                {
                    "rel":"self",
                    "href":"http://example.com:7001/OracleBAMREST/api/dataobjects/simpledataobjects/CommonAudit_DO"
                }
            ]
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/dataobjects"
        }
    ]
}

Back to Top

Examples

The following example shows how to view all aggregate types by submitting a GET request on the REST resource using cURL.

curl -i -X GET https://<hostname>/content/management/api/v1/aggregates/types

Example: Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Cache-Control: max-age=0
Content-Type: application/json
Date: Tue, 03 Jan 2017 05:35:59 GMT
Etag: "de89dcd094e498518b2d1777e0a13ed86ab3266426043d473fdbb277b175b679"
Server: Apache-Coyote/1.1
Transfer-Encoding: chunked
X-XSS-Protection: 1
x-content-type-options: nosniff

Example: Response Body

The following is an example of the response returned in JSON format. It lists all aggregate types by name and respective aggregate type URL defined in the CaaS system.

{
  "hasMore": false,
  "limit": 2,
  "count": 2,
  "items": [
    {
      "id": "CoreDef:1483957101769",
      "name": "ModelAggregateType",
      "description": "Aggregate Model Type",
      "createdby": "userName",
      "createddate": {
        "value": "2017-01-10T20:34:15.733Z",
        "timezone": "UTC",
        "description": ""
      },
      "updatedby": "userName",
      "updateddate": {
        "value": "2017-01-10T20:34:15.733Z",
        "timezone": "UTC",
        "description": ""
      },
      "fields": [
        {
          "id": "CoreAttribute:1483957090194",
          "name": "ModelAggr",
          "description": "Model of the car",
          "datatype": "text",
          "required": true,
          "valuecount": "single",
          "properties": null,
          "settings": null,
          "link": null
        },
        {
          "id": "CoreAttribute:1483957090187",
          "name": "YearAggr",
          "description": "Year of the car",
          "datatype": "number",
          "required": false,
          "valuecount": "single",
          "properties": null,
          "settings": null,
          "link": null
        }
      ],
      "properties": null,
      "links": null
    },
    {
      "id": "CoreDef:1483957101760",
      "name": "OtherAggregateType",
      "description": "Other Aggregate Type",
      "createdby": "userName",
      "createddate": {
        "value": "2017-01-10T20:34:14.397Z",
        "timezone": "UTC",
        "description": ""
      },
      "updatedby": "userName",
      "updateddate": {
        "value": "2017-01-10T20:34:14.397Z",
        "timezone": "UTC",
        "description": ""
      },
      "fields": [
        {
          "id": "CoreAttribute:1483957101732",
          "name": "TestModelAggr",
          "description": "Test model for other type",
          "datatype": "text",
          "required": true,
          "valuecount": "single",
          "properties": null,
          "settings": null,
          "link": null
        },
        {
          "id": "CoreAttribute:1483957101753",
          "name": "TestYearAggr",
          "description": "Test year for other type",
          "datatype": "number",
          "required": true,
          "valuecount": "single",
          "properties": null,
          "settings": null,
          "link": null
        }
      ],
      "properties": null,
      "links": null
    }
  ],
  "links": [
    {
      "href": "http://<hostname>/content/management/api/v1/aggregates/types?limit=2",
      "rel": "self",
      "templated": false,
      "method": "GET",
      "profile": "",
      "mediaType": ""
    },
    {
      "href": "http://<hostname>/content/management/api/v1/aggregates/types?limit=2",
      "rel": "canonical",
      "templated": false,
      "method": "GET",
      "profile": "",
      "mediaType": ""
    },
    {
      "href": "http://<hostname>/content/management/api/v1/metadata-catalog/aggregates/types",
      "rel": "describedby",
      "templated": false,
      "method": "GET",
      "profile": "",
      "mediaType": "application/schema+json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1/aggregates/types?limit=2&offset=2",
      "rel": "next",
      "templated": false,
      "method": "",
      "profile": "",
      "mediaType": ""
    },
    {
      "href": "http://<hostname>/content/management/api/v1/aggregates/types?limit=2&offset=0",
      "rel": "first",
      "templated": false,
      "method": "",
      "profile": "",
      "mediaType": ""
    },
    {
      "href": "http://<hostname>/content/management/api/v1/aggregates/types?limit=2&offset=82",
      "rel": "last",
      "templated": false,
      "method": "",
      "profile": "",
      "mediaType": ""
    }
  ],
  "offset": 0
}

Back to Top