{ "opencollection": "1.0.0", "info": { "name": "Factset Analytics Datastore About Name API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Name", "type": "folder" }, "items": [ { "info": { "name": "Factset Redirects to the Underlying Pa/spar Data Represented in a Stach Format, With No as of Date Specified.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/swivel/v1/:document/:assetName/:reportId/:tileId/:accountId", "params": [ { "name": "document", "value": "Analytics_Datastore", "type": "path", "description": "The Publisher or Analytics Datafeed document containing the report" }, { "name": "assetName", "value": "ADS_Demo.PA3", "type": "path", "description": "The PA/SPAR asset name and extension" }, { "name": "reportId", "value": "report7", "type": "path", "description": "The PA/SPAR report ID" }, { "name": "tileId", "value": "tile0", "type": "path", "description": "The PA/SPAR tile ID" }, { "name": "accountId", "value": "LARGE_CORE", "type": "path", "description": "The account ID" } ] }, "docs": "Takes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." }, { "info": { "name": "Factset Redirects to the Underlying Pa/spar Data Represented in a Stach Format.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/swivel/v1/:document/:assetName/:reportId/:tileId/:accountId/:date", "params": [ { "name": "document", "value": "Analytics_Datastore", "type": "path", "description": "The Publisher or Analytics Datafeed document containing the report" }, { "name": "assetName", "value": "ADS_Demo.PA3", "type": "path", "description": "The PA/SPAR asset name and extension" }, { "name": "reportId", "value": "report7", "type": "path", "description": "The PA/SPAR report ID" }, { "name": "tileId", "value": "tile0", "type": "path", "description": "The PA/SPAR tile ID" }, { "name": "accountId", "value": "LARGE_CORE", "type": "path", "description": "The account ID" }, { "name": "date", "value": "2023-01-01", "type": "path", "description": "The as of date for the report" } ] }, "docs": "Takes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." }, { "info": { "name": "Factset Redirects to the Underlying Insight/vault Data in a Stach Format.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/swivel/v1/:document/:assetName/:reportId/:tileId/:accountId/:configId/:date", "params": [ { "name": "document", "value": "Analytics_Datastore", "type": "path", "description": "The Analytics Datafeed document containing the report" }, { "name": "assetName", "value": "ADS_Demo.PA3", "type": "path", "description": "The PA/SPAR asset name and extension" }, { "name": "reportId", "value": "report7", "type": "path", "description": "The PA/SPAR report ID" }, { "name": "tileId", "value": "tile0", "type": "path", "description": "The PA/SPAR tile ID" }, { "name": "accountId", "value": "LARGE_CORE", "type": "path", "description": "The account ID" }, { "name": "configId", "value": "acb5150d-4333-49e7-8e33-4f7fa749691e", "type": "path", "description": "The Vault configuration ID" }, { "name": "date", "value": "2023-01-01", "type": "path", "description": "The as of date for the report" } ] }, "docs": "The inclusion of a configId in the path indicates this is for Insight/Vault mappings only, as PA/SPAR mappings do not support the concept of configuration id.\r\n\r\nTakes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." }, { "info": { "name": "Factset Get a Single Tag Definition Based on Its Name", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/tag-search/v1/tags/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the tag" } ] }, "docs": "Retrieve a tag definition based on its name" }, { "info": { "name": "Factset Gets a List of Tag Values for the Given Name", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/pub-datastore/tag-search/v1/tags/:name/values", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the tag" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of tag values depending on the name provided. Supports filtering on additional tag name value pairs, which operates as an 'AND' where the Document must have the tag name specified in the path AND the filtered parameter." }, { "info": { "name": "Factset Retrieve a Specific Media File", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/ofs/v2/media/download/:namespace/:scope/:guid/:fileName", "params": [ { "name": "namespace", "value": "", "type": "path", "description": "The namespace of the media file" }, { "name": "scope", "value": "", "type": "path", "description": "The scope of the media file" }, { "name": "guid", "value": "", "type": "path", "description": "The GUID of the file being requested" }, { "name": "fileName", "value": "", "type": "path", "description": "The name you want to show for this file in the uri." } ] }, "docs": "Factset Retrieve a Specific Media File" }, { "info": { "name": "Factset Check the existence and retrieve the headers of a spefic media file", "type": "http" }, "http": { "method": "HEAD", "url": "https://api.factset.com/ofs/v2/media/download/:namespace/:scope/:guid/:fileName", "params": [ { "name": "namespace", "value": "", "type": "path", "description": "The namespace of the media file" }, { "name": "scope", "value": "", "type": "path", "description": "The scope of the media file" }, { "name": "guid", "value": "", "type": "path", "description": "The GUID of the file being requested" }, { "name": "fileName", "value": "", "type": "path", "description": "The name you want to show for this file in the uri." } ] }, "docs": "Factset Check the existence and retrieve the headers of a spefic media file" }, { "info": { "name": "Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/accounts/v3/models/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the account to get" }, { "name": "format", "value": "", "type": "query", "description": "Optional format for the response, supported formats are JsonStach and AccountModel" } ] }, "docs": "Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data" }, { "info": { "name": "Factset Create or Update an Existing Model Account", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/accounts/v3/models/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the model account to create or update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Factset Create or Update an Existing Model Account" }, { "info": { "name": "Factset Delete Model Account, Takes an Account Path and Name and Deletes It.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/accounts/v3/models/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of model account to delete" } ] }, "docs": "Factset Delete Model Account, Takes an Account Path and Name and Deletes It." }, { "info": { "name": "Factset Get Account Endpoint, Takes an Account Name, Symbol and Returns Underlying Data for That Symbol", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/symbols/:symbol", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the account to get" }, { "name": "symbol", "value": "", "type": "path", "description": "The symbol for which data needs to be updated" }, { "name": "format", "value": "", "type": "query", "description": "Optional format for the response, supported formats are JsonStach and AccountModel" } ] }, "docs": "Factset Get Account Endpoint, Takes an Account Name, Symbol and Returns Underlying Data for That Symbol" }, { "info": { "name": "Factset Delete All Entries for a Symbol or Specific Date Entries for a Symbol From a Previously Created Account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/symbols/:symbol", "params": [ { "name": "name", "value": "", "type": "path", "description": "The filename of model account to delete" }, { "name": "symbol", "value": "", "type": "path", "description": "The symbol from the given file name to delete" }, { "name": "dates", "value": "", "type": "query", "description": "The dates from the given file name and symbol to delete (Maximum 10 dates are allowed)" } ] }, "docs": "Factset Delete All Entries for a Symbol or Specific Date Entries for a Symbol From a Previously Created Account." }, { "info": { "name": "Factset Get Account Endpoint, Takes an Account Name, Date and Returns Underlying Data for That Date", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/dates/:date", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the account to get" }, { "name": "date", "value": "", "type": "path", "description": "The date for which data needs to be updated" }, { "name": "format", "value": "", "type": "query", "description": "Optional format for the response, supported formats are JsonStach and AccountModel" } ] }, "docs": "Factset Get Account Endpoint, Takes an Account Name, Date and Returns Underlying Data for That Date" }, { "info": { "name": "Factset Delete All Entries for a Date or Specific Symbol Entries for a Date From a Previously Created Account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/dates/:date", "params": [ { "name": "name", "value": "", "type": "path", "description": "The filename of model account to delete" }, { "name": "date", "value": "", "type": "path", "description": "The date from the given file name to delete" }, { "name": "symbols", "value": "", "type": "query", "description": "The symbols from the given file name and date to delete (Maximum 10 symbols are allowed)" } ] }, "docs": "Factset Delete All Entries for a Date or Specific Symbol Entries for a Date From a Previously Created Account." }, { "info": { "name": "Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/dates/:date/symbols/:symbol", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the account to get" }, { "name": "symbol", "value": "", "type": "path", "description": "The symbol for which data needs to be updated" }, { "name": "date", "value": "", "type": "path", "description": "The date for which data needs to be updated" }, { "name": "format", "value": "", "type": "query", "description": "Optional format for the response, supported formats are JsonStach and AccountModel" } ] }, "docs": "Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data" }, { "info": { "name": "Factset Get Account Schema Endpoint, Takes an Account Name and Returns Its Schema", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/schema", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the account to get its schema" } ] }, "docs": "Factset Get Account Schema Endpoint, Takes an Account Name and Returns Its Schema" }, { "info": { "name": "Factset Get Details for the Given Prb Job", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/jobs/:type/:name", "params": [ { "name": "type", "value": "", "type": "path", "description": "The jobs type" }, { "name": "name", "value": "", "type": "path", "description": "The jobs name" }, { "name": "attribute", "value": "", "type": "query", "description": "The attribute parameter accepts a list of the given enums, separated by commas. Each of them returns the respective data associated with the job. Runs returns the run history of the job." } ] }, "docs": "Use this endpoint to fetch the documents, tasks, accounts, and/or runs for the PRB job given in the path. Please note jobs with type PD will not return tasks nor accounts so this will be ignored if given as part of the array of attributes in the request." }, { "info": { "name": "Factset Search for Publishers.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/news/publisher/searchByName", "body": { "type": "json", "data": "{}" } }, "docs": "Search for publishers by the name of the publisher." }, { "info": { "name": "Factset Details of a Timezone Identified by Name.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/basic/timezone/getByName", "params": [ { "name": "name", "value": "", "type": "query" }, { "name": "_attributes", "value": "", "type": "query", "description": "Limit the attributes returned in the response to the specified set." } ] }, "docs": "Details of a timezone identified by name, as specified by the Internet Assigned Numbers Authority. See http://www.iana.org/time-zones for further details. Not all such timezones are available on the MDG." }, { "info": { "name": "Factset Gets the Generated File", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/v1/:tenant/report-instances/:reportInstanceId/results/:reportFileName", "params": [ { "name": "tenant", "value": "", "type": "path", "description": "The code of the tenancy" }, { "name": "reportInstanceId", "value": "", "type": "path", "description": "Used to validate that report file name belongs to the report instance passed" }, { "name": "reportFileName", "value": "", "type": "path", "description": "The report file name that has to be retrieved. report file name. E.g: xyz.pdf" } ] }, "docs": "Get the generated file for a report instance. Users can fetch the generated report once the genration is finished. The report instance id and the report file name are passed in as path paramters" }, { "info": { "name": "List of portfolios.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/portfolio/name/list", "params": [ { "name": "_attributes", "value": "", "type": "query", "description": "Limit the attributes returned in the response to the specified set." }, { "name": "_sort", "value": "", "type": "query", "description": "Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 2 (possibly prefixed) attribute name(s) is allowed." } ] }, "docs": "List of portfolios." } ] } ], "bundled": true }