3.4.4.2 Message: GetResources

Topic Version1Published10/31/2016
For StandardETP v1.1

Sent from consumer to store to enumerate the children of a given URI. Every ETP store MUST support a URI of “eml://”. The store sends one or more child Resource messages (defined below). It the URI is malformed, invalid, or does not exist, the store sends the exception.

If the URI exists in the store, but simply has no children, the producer MUST send an Acknowledge message (1001) with Protocol 3, bit 0x04 set on the header messageFlags and the correlationId set to the request messageId.

Note that because this is the Discovery protocol (not static object or query), the meaning of the "Get" message is unambiguously "get child URIs". So if you do a Get on /well(‘23423423432423’), you get back its wellbores—NOT the static well object itself.

Message Type ID: 1

Correlation Id Usage: n/a

Multi-part: n/a

Sent by: customer

Attribute

Description

Data Type

Min

Max

uri

 

string

1

1

Avro Source

{

      "type": "record",

      "namespace": "Energistics.Protocol.Discovery",

      "name": "GetResources",

      "messageType": "1",

      "protocol": "3",

      "senderRole": "customer",

      "protocolRoles": "store,customer",

      "fields":

     [

         { "name": "uri", "type": "string" }

     ]

}