{ "opencollection": "1.0.0", "info": { "name": "Factset Analytics Datastore About Templates API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Templates", "type": "folder" }, "items": [ { "info": { "name": "Factset Get Linked Pa Templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/linked-templates", "params": [ { "name": "directory", "value": "", "type": "query", "description": "Get linked PA templates in path." }, { "name": "documentDirectory", "value": "", "type": "query", "description": "Get linked PA templates for documents in document path" }, { "name": "documentName", "value": "", "type": "query", "description": "Get linked PA templates for documents by document name" } ] }, "docs": "This endpoint returns the list of linked PA templates in given path." }, { "info": { "name": "Factset Create a Linked Pa Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/pa/v3/linked-templates", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\"" }, { "info": { "name": "Factset Get Linked Pa Template by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/linked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a linked PA template" } ] }, "docs": "This endpoint fetches the linked PA template settings." }, { "info": { "name": "Factset Update a Linked Pa Template", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/pa/v3/linked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a linked PA template" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows the user to change the request body and description from an existing template.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdeta" }, { "info": { "name": "Factset Delete a Linked Pa Template.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/pa/v3/linked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a linked PA template" } ] }, "docs": "This endpoint deletes an existing linked PA template." }, { "info": { "name": "Factset Get Unlinked Pa Templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates", "params": [ { "name": "directory", "value": "", "type": "query", "description": "Get unlinked PA templates in path." }, { "name": "category", "value": "", "type": "query", "description": "Get unlinked PA templates by category." } ] }, "docs": "This endpoint returns the list of unlinked PA templates." }, { "info": { "name": "Factset Create Unlinked Pa Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a template which is not linked to any specific PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We canno" }, { "info": { "name": "Factset Get Unlinked Pa Template Details by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for an unlinked PA template" } ] }, "docs": "This endpoint fetches the template settings." }, { "info": { "name": "Factset Update Unlinked Pa Template", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for an unlinked PA template" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing unlinked PA template.\r\n\r\nRemarks:\r\n \r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override t" }, { "info": { "name": "Factset Delete Unlinked Pa Template", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for an unlinked PA template" } ] }, "docs": "This endpoint deletes an existing unliked PA template." }, { "info": { "name": "Factset Get Default Unlinked Pa Template Types.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates/template-types" }, "docs": "This endpoint fetches default unlinked PA template types." }, { "info": { "name": "Factset Get Unlinked Pa Template Type Details by Id.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates/template-types/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for an unlinked PA template type" } ] }, "docs": "This endpoint fetches the unlinked PA template type details." } ] } ], "bundled": true }