[{"_id":"65405ab90dbbbeae9b471331","referenceApi":"d2ba3886-77fd-432f-a9a7-38b720182cb5","title":"Reports API","openApi":"{\"openapi\":\"3.0.1\",\"info\":{\"title\":\"Reports API\",\"version\":\"v1\",\"description\":\"The Reports API provides endpoints for retrieving a list of available reports, executing reports with specified parameters, and checking the status of report operations. It allows users to interact with the reporting system, schedule reports for execution, and retrieve the generated data.\"},\"servers\":[{\"url\":\"https://api-uat.onesourcetax.com/trusts/v1/reports\",\"description\":\"UAT server for trusts datasets\"},{\"url\":\"https://api-apac.onesourcetax.com/trusts/v1/reports\",\"description\":\"APAC server for trusts datasets\"}],\"paths\":{\"/definitions\":{\"get\":{\"tags\":[\"Reports\"],\"summary\":\"Retrieve complete list of all available reports\",\"description\":\"Retrieves a comprehensive list of all available reports, including both standard and custom types.\",\"operationId\":\"Reports_GetReports\",\"parameters\":[{\"name\":\"Authorization\",\"in\":\"header\",\"description\":\"Security token used to authenticate the user and authorize access to the API. It must be included in the request header.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Successfully retrieved the report list. Indicates that the request was processed correctly and the user is authorized.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportListResponse\"}},\"text/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportListResponse\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportListResponse\"}},\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportListResponse\"}}}}}}},\"/definitions/{id}\":{\"get\":{\"tags\":[\"Reports\"],\"summary\":\"Retrieve Report Input Parameters and Output Fields\",\"description\":\"Fetches the input parameters required to run a specific report and lists its output fields.\",\"operationId\":\"Reports_GetReportMetdata\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"The unique identifier of the report definition. This ID is used to specify the report for which metadata is being requested.\",\"required\":true,\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},{\"name\":\"Authorization\",\"in\":\"header\",\"description\":\"Security token used to authenticate the user and authorize access to the API. It must be included in the request header.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Successfully retrieved the metadata for the specified report. Indicates that the request was processed correctly and the user is authorized.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportMetadata\"}},\"text/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportMetadata\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportMetadata\"}},\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportMetadata\"}}}}}}},\"/\":{\"post\":{\"tags\":[\"Reports\"],\"summary\":\"Execute Reports and Retrieve Data\",\"description\":\"This endpoint schedules reports for execution by using specified input parameters and then retrieves the data that matches those parameters.\",\"operationId\":\"Reports_GetData\",\"parameters\":[{\"name\":\"Authorization\",\"in\":\"header\",\"description\":\"Security token required to authenticate the user and authorize access to the API. Must be included in the request header.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"Input parameters necessary for the report execution. This includes all necessary filters and options.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportInput\"}},\"text/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportInput\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportInput\"}},\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportInput\"}},\"application/x-www-form-urlencoded\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportInput\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully queued the report for execution and retrieved matching data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput\"}},\"text/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput\"}},\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput\"}}}}},\"x-codegen-request-body-name\":\"input\"}},\"/operations/{id}\":{\"get\":{\"tags\":[\"Reports\"],\"summary\":\"Check Report Status by Operation ID\",\"description\":\"Fetches the status of a specific report based on the operation ID provided from the Queue reports API.\",\"operationId\":\"Reports_GetOperationStatusFromCache\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"The unique identifier (UUID) of the report operation whose status is being queried.\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}},{\"name\":\"Authorization\",\"in\":\"header\",\"description\":\"Security token required to authenticate the user and authorize access to the API. This token must be included in the request header.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Successfully retrieved the status of the report operation.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportStatusResponse\"}},\"text/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportStatusResponse\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportStatusResponse\"}},\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportStatusResponse\"}}}},\"404\":{\"description\":\"The specified report operation ID was not found.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/System.Web.Http.Results.NotFoundResult\"}},\"text/json\":{\"schema\":{\"$ref\":\"#/components/schemas/System.Web.Http.Results.NotFoundResult\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/System.Web.Http.Results.NotFoundResult\"}},\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/System.Web.Http.Results.NotFoundResult\"}}}}}}},\"/{id}\":{\"get\":{\"tags\":[\"Reports\"],\"summary\":\"Retrieve Data from Queued Report\",\"description\":\"Retrieves the report data based on the input parameters provided during the report queueing process.\",\"operationId\":\"Reports_GetDataFromCache\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"The unique identifier (UUID) of the report operation from which data is being fetched.\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}},{\"name\":\"offset\",\"in\":\"query\",\"description\":\"The starting point from which to fetch the report data, used for pagination.\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},{\"name\":\"limit\",\"in\":\"query\",\"description\":\"The maximum number of report data items to return, used for pagination.\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},{\"name\":\"Authorization\",\"in\":\"header\",\"description\":\"Security token required to authenticate the user and authorize access to the API. Must be included in the request header.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Successfully retrieved the report data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput\"}},\"text/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput\"}},\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportOutput\"}}}},\"404\":{\"description\":\"The specified report operation ID was not found.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/System.Web.Http.Results.NotFoundResult\"}},\"text/json\":{\"schema\":{\"$ref\":\"#/components/schemas/System.Web.Http.Results.NotFoundResult\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/System.Web.Http.Results.NotFoundResult\"}},\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/System.Web.Http.Results.NotFoundResult\"}}}}}}}},\"components\":{\"schemas\":{\"TRTA.Athena.Models.Api.V4.Reports.ReportListResponse\":{\"type\":\"object\",\"description\":\"A response schema representing a list of reports. It encapsulates the details of each report in an array format.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"An array of reports. Each item in the array represents a single report with its full details.\",\"items\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.Report\"}}}},\"TRTA.Athena.Models.Api.V4.Reports.Report\":{\"type\":\"object\",\"description\":\"Represents the structure of a report, detailing its unique identifier, name, and a comprehensive description.\",\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The unique identifier of the report. This is used to reference the report uniquely across the system.\",\"format\":\"int32\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the report. This provides a brief label by which the report is commonly known.\"},\"description\":{\"type\":\"string\",\"description\":\"Provides a detailed description of the report. This elaborates on what the report entails, its purpose, and how it should be interpreted.\"}}},\"TRTA.Athena.Models.Api.V4.Reports.ReportMetadata\":{\"type\":\"object\",\"description\":\"Represents the metadata associated with a specific report, including its identifier, name, and the input parameters required to generate the report.\",\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The unique identifier for the report. This ID is used to uniquely reference the report within the system.\",\"format\":\"int32\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the report. This provides a clear identification of the report and is commonly used for display purposes.\"},\"parameters\":{\"type\":\"array\",\"description\":\"A list of input parameters required for running the report. Each parameter defines a specific piece of data needed to generate the report accurately.\",\"items\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportParameter\"}},\"resultFields\":{\"type\":\"array\",\"description\":\"An array of result columns that specifies the fields included in the report output. Each item represents a specific field detailing its characteristics and data type.\",\"items\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportField\"}}}},\"TRTA.Athena.Models.Api.V4.Reports.ReportParameter\":{\"type\":\"object\",\"description\":\"Represents a single input parameter required for generating a report. This schema details the parameter's name, description, data type, format, and whether it can accept multiple values.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the parameter. This is used as an identifier in the report configuration and user interface.\"},\"description\":{\"type\":\"string\",\"description\":\"Provides a detailed description of the parameter, explaining its purpose and how it affects the report generation.\"},\"dataType\":{\"type\":\"string\",\"description\":\"Specifies the type of data that the parameter accepts, such as 'string', 'date', etc.\"},\"format\":{\"type\":\"string\",\"description\":\"Defines the expected format of the parameter value, especially important for data types like date (e.g., 'yyyy-mm-dd').\"},\"acceptMultiple\":{\"type\":\"boolean\",\"description\":\"Indicates whether the parameter can accept multiple values. If true, multiple values can be passed together for this parameter.\"}}},\"TRTA.Athena.Models.Api.V4.Reports.ReportField\":{\"type\":\"object\",\"description\":\"Describes an individual field (column) in the report output, including its name, display caption, and data type.\",\"properties\":{\"Name\":{\"type\":\"string\",\"description\":\"The identifier name of the field as used in the report's data structure.\"},\"Caption\":{\"type\":\"string\",\"description\":\"The human-readable label for the field, used as the column header in report displays.\"},\"DataType\":{\"type\":\"string\",\"description\":\"Specifies the type of data the field holds, such as 'string', 'integer', 'date'\"}}},\"TRTA.Athena.Models.Api.V4.Reports.ReportInput\":{\"type\":\"object\",\"description\":\"Represents the input data structure required to initiate a report generation, including the report definition ID and any necessary parameters.\",\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The unique identifier of the report definition. This ID is used to specify which report configuration to use for generating the report.\",\"format\":\"int32\"},\"parameters\":{\"type\":\"array\",\"description\":\"A list of parameters required for generating the report. Each item represents a specific input needed to customize and execute the report.\",\"items\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportParameterInput\"}}}},\"TRTA.Athena.Models.Api.V4.Reports.ReportParameterInput\":{\"type\":\"object\",\"description\":\"Represents a single input parameter for a report, detailing the parameter's name and the value it should take for the report generation.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The identifier name of the parameter. This name is used to match the parameter with its corresponding definition in the report configuration.\"},\"value\":{\"type\":\"string\",\"description\":\"The value assigned to the parameter for the report generation. This value influences the output or behavior of the report based on the parameter's role.\"}}},\"TRTA.Athena.Models.Api.V4.Reports.ReportOutput\":{\"type\":\"object\",\"description\":\"Represents the output data of a generated report, detailing the report's unique identifiers, name, and the parameters used to generate it.\",\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The unique identifier for the report. This ID is used to uniquely reference the report within the system.\",\"format\":\"int32\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the report as specified during its creation. This is used for easy identification and reference.\"},\"runId\":{\"type\":\"string\",\"description\":\"A unique identifier for the specific execution or run of the report. This helps in tracking and referencing specific instances of report generation.\",\"format\":\"uuid\",\"example\":\"00000000-0000-0000-0000-000000000000\"},\"parameters\":{\"type\":\"array\",\"description\":\"A list of parameters that were supplied as input for generating the report. This helps in understanding the context and configuration under which the report was generated.\",\"items\":{\"$ref\":\"#/components/schemas/TRTA.Athena.Models.Api.V4.Reports.ReportParameterInput\"}},\"status\":{\"type\":\"string\",\"description\":\"Status of report (In-Progress/Ready/Invalid)\"},\"items\":{\"type\":\"array\",\"description\":\"Report data, It will only have data when status is Ready.\",\"items\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}},\"count\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"TRTA.Athena.Models.Api.V4.Reports.ReportStatusResponse\":{\"type\":\"object\",\"description\":\"Represents the status response of a report request, including the current status, resource location if available, and the count of reports processed.\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"The current status of the report processing. Typical values might include 'Pending', 'Processing', 'Completed', or 'Failed'.\"},\"resourceLocation\":{\"type\":\"string\",\"description\":\"The URL or URI location where the generated report or further details can be accessed, if applicable.\"},\"count\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The number of items or reports processed or affected by the request.\"}}},\"System.Web.Http.Results.NotFoundResult\":{\"type\":\"object\",\"description\":\"Represents a standard HTTP 404 Not Found result, indicating that the requested resource was not found on the server.\",\"properties\":{\"Request\":{\"type\":\"object\",\"description\":\"Contains details about the HTTP request that resulted in a Not Found response. This object is read-only.\",\"properties\":{},\"readOnly\":true}}}}},\"x-original-swagger-version\":\"2.0\"}"}]