Using the Describe Parameter to Return Child Business Component Metadata
You use the OpenAPI describe parameter to retrieve metadata description for a child Business Component by appending it to a HTTP GET request to the resource's URI. It lists all the fields, path to catalog of grandchildren, and request and response structure with HTTP codes.
The following request uses the describe parameter to return child Business Component metadata, that is, the Contact child Business Component Contact, under the Account parent Business Component in OpenAPI 2.0 format:
URI: http://ServerName:port/siebel/v1.0/data/Account/Account/1-6/Contact/describe?openapiversion=2
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request body: None
Here are the response details for a successful request:
HTTP Code: 200
Content-Type: application/json
- Response body:
{ "definitions":{ "data_Account_Account_{key}_Contact_":{ "type":"object", "required":[], "properties":[], "tags":[ { "name":"data/Account/Account/{key}/Contact/", "description":"Operations available on data/Account/Account/{key}/Contact/", "externalDocs":{ "description":"Find Out More", "url":"" } }, "paths":{ "/data/Account/Account/{key}/Contact/":{ "get":{ "tags":[ "data_Account_Account_{key}_Contact_" ], "summary":"", "description":"", "operationId":"data_Account_Account_{key}_Contact_/get", "produces":[ "application/xml", "application/json" ], "responses":{ "200":{"description":"Successful Operation"}, "204":{"description":"No Resource Found"}, "404":{ "description":"There is no data for the requested resource"}, "500":{"description":"Internal Server Error"} }, "parameters":[ { "name":"key", "in":"path", "description":"", "required":true, "type":"string" } ], "security":[ { "Basic Auth":[], "OAuth 2.0":[] } ] }, "post":{ "tags":[ "data_Account_Account_{key}_Contact_" ], "summary":"", "description":"", "operationId":"data_Account_Account_{key}_Contact_/post", "produces":[ "application/xml", "application/json" ], "consumes":[ "application/xml", "application/json" ], "responses":{ "200":{"description":"Successful Operation"}, "204":{"description":"No Resource Found"}, "404":{"description":"There is no data for the requested resource"}, "500":{"description":"Internal Server Error"} }, "parameters":[ { "in":"body", "name":"body", "description":"", "required":true, "schema":{ "$ref":"#/definitions/data_Account_Account_{key}_Contact_" } } ], "security":[ { "Basic Auth":[], "OAuth 2.0":[] } ] } } } }
The following request uses the describe parameter to return child Business Component metadata, that is, the Contact child Business Component Contact, under the Account parent Business Component in OpenAPI 3.0 format:
-
URI: http://ServerName:port/siebel/v1.0/data/Account/Account/1-6/Contact/describe
-
HTTP Method: GET
-
Content-Type: application/json
-
Authorization: Basic
-
Request body: None
Here are the response details for a successful request:
-
HTTP Code: 200
-
Content-Type: application/json
-
Response body:
{
"paths": {
"/data/Account/Account/{account_key}/Contact/": {
"get": {
"tags": [
"data/Account/Account/{account_key}/Contact/"
],
"operationId": "data_Account_Account__account_key__Contact__get",
"parameters": [{
"name": "account_key",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}],
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/data_Account_Account__account_key__Contact_get_all_response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/data_Account_Account__account_key__Contact_get_all_response"
}
}
}
},
"204": {
"description": "No Resource Found",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "There is no data for the requested resource",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [{
"basicAuth": [],
"oAuth2.0": []
}]
},
"put": {
"tags": [
"data/Account/Account/{account_key}/Contact/"
],
"operationId": "data_Account_Account__account_key__Contact__put",
"parameters": [{
"name": "account_key",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "excludeEmptyFieldsInResponse",
"in": "query",
"schema": {
"type": "string",
"default": "false"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/data_Account_Account__account_key__Contact_"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/data_Account_Account__account_key__Contact_"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/data_Account_Account__account_key__Contact_put_post_response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/data_Account_Account__account_key__Contact_put_post_response"
}
}
}
},
"204": {
"description": "No Resource Found",
"content": {}
},
"304": {
"description": "Not Modified",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"404": {
"description": "There is no data for the requested resource",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"security": [{
"basicAuth": [],
"oAuth2.0": []
}],
"x-codegen-request-body-name": "body"
}
}
},
"components": {
"schemas": {
"data_Account_Account__account_key__Contact_": {
"required": [],
"type": "object",
"properties": ""
}
}
}
}