{ "opencollection": "1.0.0", "info": { "name": "Factset Analytics Datastore About Optimizations API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Optimizations", "type": "folder" }, "items": [ { "info": { "name": "Factset Create and Run Afi Optimization", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates and runs AFI optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document." }, { "info": { "name": "Factset Get Afi Optimization Parameters by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" } ] }, "docs": "This is the endpoint that returns the optimization parameters passed for an optimization." }, { "info": { "name": "Factset Create or Update Afi Optimization and Run It.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/:id", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the AFI optimization specified in the PUT body parameters. It also allows the creation of new AFI optimization with custom id." }, { "info": { "name": "Factset Cancel Afi Optimization by Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted optimization." }, { "info": { "name": "Factset Get Afi Optimization Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get Afi Optimization Result by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/:id/result", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get AFI optimization status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested optimization." }, { "info": { "name": "Factset Create and Run Npo Optimization", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates and runs NPO optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document." }, { "info": { "name": "Factset Get Npo Optimization Parameters by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" } ] }, "docs": "This is the endpoint that returns the optimization parameters passed for an optimization." }, { "info": { "name": "Factset Create or Update Npo Optimization and Run It.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/:id", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the NPO optimization specified in the PUT body parameters. It also allows the creation of new NPO optimization with custom id." }, { "info": { "name": "Factset Cancel Npo Optimization by Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted optimization." }, { "info": { "name": "Factset Get Npo Optimization Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get Npo Optimization Result by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/:id/result", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get NPO optimization status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested optimization." }, { "info": { "name": "Factset Create and Run Fpo Optimization", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint runs FPO optimization specified in the POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the strategy document." }, { "info": { "name": "Factset Get Fpo Optimization Parameters by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" } ] }, "docs": "This is the endpoint that returns the optimization parameters passed for a calculation." }, { "info": { "name": "Factset Create or Update Fpo Optimization and Run It.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/:id", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the FPO optimization specified in the PUT body parameters. It also allows the creation of new FPO optimization with custom id." }, { "info": { "name": "Factset Cancel Fpo Optimization by Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted optimization." }, { "info": { "name": "Factset Get Fpo Optimization Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get Fpo Optimization Result by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/:id/result", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get FPO optimization status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON." } ] } ], "bundled": true }