getRequests

Retrieve Bloomberg Hypermedia request information

Since R2023b

Syntax

[requestList,response] = getRequests(c,userCatalog)

[requestList,response] = getRequests(c,userCatalog,requestID)

Description

[requestList,response] = getRequests(c,userCatalog) retrieves Bloomberg^® Hypermedia request information for all available universes, where c is the Bloomberg Hypermedia connection object and userCatalog is your catalog ID from Bloomberg.

[requestList,response] = getRequests(c,userCatalog,requestID) retrieves Bloomberg Hypermedia request information for a specified request contained in the request identifier requestID.

Examples

Retrieve Bloomberg Hypermedia Request Information for All Available Universes

Access information about data requests.

Create a Bloomberg Hypermedia connection object by using the API key provided by Bloomberg.

credentialsString = '{"client_id":"89beaeab724bbdf5e186b733c58af2","client_secret":"77050429aee81eb31793fb10fa4301c54911db545de8b2990252ffe2b56b11","name":"BloombergHAIDevelopment","scopes":["eap","beapData","reportingapi"],"expiration_date":1699198358934,"created_date":1651764758934}'
c = bloombergHypermedia(credentialsString)

c = 
 
  bloombergHypermedia with properties:

      TimeOut: 200.00

Specify your catalog ID and use the getRequests function. Replace "123" with your login credentials for the catalog you want to access.

userCatalog = "123";
[requestList,response] = getRequests(c,userCatalog)

requestList =

  8×7 table

               x_id                   x_type                         description                            identifier                        issued                            modified                    title     
    __________________________    _______________    ____________________________________________    _________________________    _______________________________    _______________________________    ______________

    {'r20220524135441e10a41/'}    {'DataRequest'}    {'Test request with universe and fieldList'}    {'r20220524135441e10a41'}    {'2022-05-24T17:54:42.376546Z'}    {'2022-05-24T17:54:42.376546Z'}    {'My Request'}
    {'r2022052409132770971c/'}    {'DataRequest'}    {'Test request with universe and fieldList'}    {'r2022052409132770971c'}    {'2022-05-24T13:13:29.053194Z'}    {'2022-05-24T13:13:29.053194Z'}    {'My Request'}
    {'r20220523195612215b68/'}    {'DataRequest'}    {'Test request with universe and fieldList'}    {'r20220523195612215b68'}    {'2022-05-23T23:56:13.597985Z'}    {'2022-05-23T23:56:13.597985Z'}    {'My Request'}
    {'r20220523191338dc238f/'}    {'DataRequest'}    {'Test request with universe and fieldList'}    {'r20220523191338dc238f'}    {'2022-05-23T23:13:39.520691Z'}    {'2022-05-23T23:13:39.520691Z'}    {'My Request'}
    {'r20220518163141cc2b41/'}    {'DataRequest'}    {'Test request with universe and fieldList'}    {'r20220518163141cc2b41'}    {'2022-05-18T20:31:41.795212Z'}    {'2022-05-18T20:31:41.795212Z'}    {'My Request'}
    {'r2022051715474169f59b/'}    {'DataRequest'}    {'Test request with universe and fieldList'}    {'r2022051715474169f59b'}    {'2022-05-17T19:47:42.395041Z'}    {'2022-05-17T19:47:42.395041Z'}    {'My Request'}
    {'r2022020120101927c14e/'}    {'DataRequest'}    {'Test request with universe and fieldList'}    {'r2022020120101927c14e'}    {'2022-02-02T01:10:20.290660Z'}    {'2022-02-02T01:10:20.290660Z'}    {'My Request'}
    {'r202202011239375f2c43/'}    {'DataRequest'}    {'Test request with universe and fieldList'}    {'r202202011239375f2c43'}    {'2022-02-01T17:39:38.552949Z'}    {'2022-02-01T17:39:38.552949Z'}    {'My Request'}


response = 

  ResponseMessage with properties:

    StatusLine: 'HTTP/1.1 303 SEE OTHER'
    StatusCode: SeeOther
        Header: [1×14 matlab.net.http.HeaderField]
          Body: [1×1 matlab.net.http.MessageBody]
     Completed: 1

You can also access request information about a specific universe. Specify the optional input argument, which holds the request ID, and use the getRequests function.

requestID = "r20230124092446a1600b"
[data,response] = getRequests(c,userCatalog,requestID)

data =

  1×14 table

    x_context        x_id           x_type                                            dataset                                                        description                                                            fieldList                                            formatting           identifier                        issued                            modified                pricingSourceOptions        title                                     trigger                                                                    universe                                    
    __________    __________    _______________    ______________________________________________________________________________    ____________________________________________    ________________________________________________________________________________________    __________    _________________________    _______________________________    _______________________________    ____________________    ______________    ________________________________________________________________    _______________________________________________________________________________

    1×1 struct    {0×0 char}    {'DataRequest'}    {'https://api.bloomberg.com/eap/catalogs/123/datasets/r20230124092446a1600b/'}    {'Test request with universe and fieldList'}    {'https://api.bloomberg.com/eap/catalogs/146/fieldLists/fieldList20230124092443a3974f/'}    1×1 struct    {'r20230124092446a1600b'}    {'2023-01-24T14:24:47.272665Z'}    {'2023-01-24T14:24:47.272665Z'}         1×1 struct         {'My Request'}    {'https://api.bloomberg.com/eap/catalogs/bbg/triggers/oneshot/'}    {'https://api.bloomberg.com/eap/catalogs/146/universes/u20230124092442f9fffa/'}


response = 

  ResponseMessage with properties:

    StatusLine: 'HTTP/1.1 200 OK'
    StatusCode: OK
        Header: [1×15 matlab.net.http.HeaderField]
          Body: [1×1 matlab.net.http.MessageBody]
     Completed: 0

Input Arguments

c — Bloomberg Hypermedia connection

Bloomberg Hypermedia object

Bloomberg Hypermedia connection, specified as a Bloomberg Hypermedia object.

userCatalog — User catalog identifier

string scalar | character vector

User catalog identifier, specified as a character vector or string scalar.

requestID — Request identifier

string scalar | character vector

Request identifier, specified as a character vector or string scalar.

Output Arguments

requestList — List of available requests or information about specific request

table

List of available requests or information about a specific request, returned as a table.

response — HTTP request response

ResponseMessage object

HTTP request response, returned as a ResponseMessage object. For details, see matlab.net.http.ResponseMessage.

Version History

Introduced in R2023b