Response Message Bodies

All Oracle FS System RESTful API responses contain a message body. At a minimum, the message body contains the ID and the FQN of the Oracle FS System task that performed or is performing the request. Depending on the request made, additional information is returned.

The value you specify for the Accept HTTP header field in the request determines the format of the message body that is returned. The content of the message body contains the same XML tags or JSON objects as what the Oracle FS CLI returns for the equivalent command request minus the ResponseHeader set of tags.

The following example is an XML message body:

<ResponseBody> 
  <CLIResponse>
    <TaskInformation>
 			<TaskGuid>aGuid</TaskGuid>
  			<TaskFqn>/someFQN</TaskFqn>
    </TaskInformation>
	    Tags and values specific to the request.
    </CLIResponse>
	</ResponseBody>

The following example is a JSON message body:

{“ResponseBody” : {
	“CLIResponse” : { 
“TaskInformation” : {
 			“TaskGuid” : “aGuid”,
  			“TaskFqn” : “/someFQN”
},
	JSON objects specific to the request
 	}
}
}

For example, if these volume groups /finance and /legal are defined on the Oracle FS System, the XML‑based request and response for retrieving all volume groups would be the following.

Note: The default volume group (/) is included in the response.

For XML, the message body looks like the following example:

Request:
GET https://<oraclefs_ip_or_dns>:8085/v1/volume_group HTTP/1.1
Accept: text/xml
Content-Type: text/xml

Response:
HTTP/1.1 200 OK
Date: <some date and time>
Connection: close
Content-Type: text/xml

<ResponseBody>
  <CLIResponse>
    <TaskInformation>
     <TaskGuid>4130303030303142A13F11D5EB113971</TaskGuid>
     <TaskFqn>/GetVolumeGroup/3901/administrator</TaskFqn>
    </TaskInformation>
     <VolumeGroup>
      <Fqn>/</Fqn>
      <Id>4130303030303142A10411D05C5B4344</Id>
     </VolumeGroup>
     <VolumeGroup>
      <Fqn>/finance</Fqn>
      <Id>4130303030303142A10411D1CE7C4D78</Id>
     </VolumeGroup>
     <VolumeGroup>
      <Fqn>/legal</Fqn>
      <Id>4130303030303142A10411D1CE7C4C55</Id>
    </VolumeGroup>
  </CLIResponse>
</ResponseBody>

For JSON, the message body looks like the following example:

Request:
GET https://<oraclefs_ip_or_dns>:8085/v1/volume_group HTTP/1.1
Accept: text/json
Content-Type: text/json

Response:
HTTP/1.1 200 OK
Date: <some date and time>
Connection: close
Content-Type: text/xml

{“ResponseBody” : { 
	“CLIResponse” : { 
“TaskInformation” : {
 			“TaskGuid” : “aGuid”,
  			“TaskFqn” : “/someFQN”
},
	“VolumeGroup” : [
{“Fqn” : “/”,
		 “Id” : “4130303030303142A10411D05C5B4344”
		},
		{“Fqn” : “/finance”,
  		 “Id” : “4130303030303142A10411D1CE7C4D78”
		},
		{“Fqn” : “/legal”,
  		“Id” : “4130303030303142A10411D1CE7C4C55”
		}
	]
}
  }
}