getTriggers

Retrieve Bloomberg Hypermedia trigger information

Since R2023b

collapse all in page

Syntax

[triggerList,response] = getTriggers(c,userCatalog,triggerID)

Description

[triggerList,response] = getTriggers(c,userCatalog,triggerID) retrieves Bloomberg® Hypermedia trigger information, where c is the Bloomberg Hypermedia connection object, userCatalog is your catalog ID from Bloomberg, and triggerID is the trigger identifier.

example

Examples

collapse all

Retrieve trigger information about all available requests for a given universe by using the getTriggers function.

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 getTriggers function to retrieve trigger information. Omitting the triggerID input argument returns trigger information about all available requests. 

userCatalog = "bbg";
[triggersList,response] = getTriggers(c,userCatalog)
triggersList = 

12x7 table


 x_id             x_type                                     description                                                                                 identifier         issued           modified           title
____________ _______________________ ______________________________________________________________________________________________________________________________________________________________________   __________ _______________________________ _______________________________  _________________________ 
{'lo12pm/' } {'BvalSnapshotTrigger'} {'Schedule a request for a BVAL cash security valuation snapshot at 12:00 in London. London snapshots include European asset backed security valuations.'              } {'lo12pm' } {'2021-05-12T10:40:56.617063Z'} {'2021-05-12T10:40:56.617063Z'} {'London 12 PM' } 
{'lo3pm/' } {'BvalSnapshotTrigger'} {'Schedule a request for a BVAL cash security valuation snapshot at 15:00 in London. London snapshots include European asset backed security valuations.' } {'lo3pm' } {'2021-05-12T10:40:56.541710Z'} {'2021-05-12T10:40:56.541710Z'} {'London 3 PM' } 
{'lo4pm/' } {'BvalSnapshotTrigger'} {'Schedule a request for a BVAL cash security valuation snapshot at 16:15 in London. London snapshots include European asset backed security valuations.' } {'lo4pm' } {'2021-05-12T10:40:56.409099Z'} {'2021-05-12T10:40:56.409099Z'} {'London 4:15 PM' } 
{'ny3pm/' } {'BvalSnapshotTrigger'} {'Schedule a request for a BVAL cash security valuation snapshot at 15:00 in New York. New York snapshots include Municipal, structured product, and European asset backed security valuations.'} {'ny3pm' } {'2021-05-12T10:40:56.322681Z'} {'2021-05-12T10:40:56.322681Z'} {'New York 3 PM' } 
{'ny4pm/' } {'BvalSnapshotTrigger'} {'Schedule a request for a BVAL cash security valuation snapshot at 16:00 in New York. New York snapshots include Municipal, structured product, and European asset backed security valuations.'} {'ny4pm' } {'2021-05-12T10:40:56.177794Z'} {'2021-05-12T10:40:56.177794Z'} {'New York 4 PM' } 
{'sh5pm/' } {'BvalSnapshotTrigger'} {'Schedule a request for a BVAL cash security valuation snapshot at 17:00 in Shanghai.' } {'sh5pm' } {'2021-05-12T10:40:56.065967Z'} {'2021-05-12T10:40:56.065967Z'} {'Shanghai 5 PM' } 
{'sy5pm/' } {'BvalSnapshotTrigger'} {'Schedule a request for a BVAL cash security valuation snapshot at 17:00 in Sydney.' } {'sy5pm' } {'2021-05-12T10:40:56.001790Z'} {'2021-05-12T10:40:56.001790Z'} {'Sydney 5 PM' } 
{'to3pm/' } {'BvalSnapshotTrigger'} {'Schedule a request for a BVAL cash security valuation snapshot at 15:00 in Tokyo. Tokyo snapshots include Japanese mortgage-backed security valuations.' } {'to3pm' } {'2021-05-12T10:40:55.867717Z'} {'2021-05-12T10:40:55.867717Z'} {'Tokyo 3 PM' }
{'to4pm/' } {'BvalSnapshotTrigger'} {'Schedule a request for a BVAL cash security valuation snapshot at 16:00 in Tokyo. Tokyo snapshots include Japanese mortgage-backed security valuations.' } {'to4pm' } {'2021-05-12T10:40:55.763853Z'} {'2021-05-12T10:40:55.763853Z'} {'Tokyo 4 PM' } 
{'to5pm/' } {'BvalSnapshotTrigger'} {'Schedule a request for a BVAL cash security valuation snapshot at 17:00 in Tokyo. Tokyo snapshots include Japanese mortgage-backed security valuations.' } {'to5pm' } {'2021-05-12T10:40:55.655269Z'} {'2021-05-12T10:40:55.655269Z'} {'Tokyo 5 PM' } 
{'oneshot/'} {'ScheduledTrigger' } {'Schedule a request to run once only (a oneshot request), no sooner than 15 minutes after request submission.' } {'oneshot'} {'2021-02-19T12:47:09.842828Z'} {'2021-02-19T12:47:09.842828Z'} {'Run Once (Oneshot)' } 
{'submit/' } {'SubmitTrigger' } {'Process the request as soon as it's submitted. This will use ad hoc scheduling functionality.' } {'submit' } {'2019-04-29T10:52:17.127424Z'} {'2019-04-29T10:52:17.156772Z'} {'On Submission Trigger'} 


response = ResponseMessage with properties: 

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

Input Arguments

collapse all

Bloomberg Hypermedia connection, specified as a Bloomberg Hypermedia object.

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

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

Output Arguments

collapse all

List of triggers, returned as a MATLAB® table.

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

Version History

Introduced in R2023b

See Also

| | | | | | | | |

Topics