action beezup_get_rules_executions { label: "Get the rules execution history" provider: beezup method: GET path: "/v2/user/analytics/{storeId}/rules/executions" encoding: json input: { type: "object" properties: { pageNumber: { type: "integer" } pageSize: { type: "integer" } storeId: { type: "string" format: "guid" } } required: ["pageNumber", "pageSize", "storeId"] additionalProperties: false } output: { type: "object" properties: { executions: { type: "array" description: "The rules executions history" items: { type: "object" required: ["ruleId", "ruleName", "status", "executionSource"] properties: { activeAffectedProductCount: { type: "integer" description: "The count of affected active products" } affectedChannelCount: { type: "integer" description: "The count of affected Channels across all products" } affectedProductCount: { type: "integer" description: "The count of affected products, active or not" } completedUtcDate: { type: "string" format: "date-time" description: "The completed utc date of the execution of the rule" } errorType: { type: "string" description: "The error type for this execution if any" enum: ["ChannelNotPresent", "StoreIsInSystemBlockState"] } executionSource: { type: "string" description: "The requestor type for the execution of the rule" enum: ["Scheduler", "User"] } links: { type: "object" description: "Links to retrieve/action on this rule execution" properties: { rule: { type: "object" } } } optimisationActionName: { type: "string" description: "The optimisation action" enum: ["reenable", "disable"] } reportUrl: { type: "string" description: "The url for the excel report for this execution" } ruleId: { type: "string" format: "guid" description: "The rule identifier" } ruleName: { type: "string" description: "The name of the rule" } startedUtcDate: { type: "string" format: "date-time" description: "The start utc date of the execution of the rule" } status: { type: "string" description: "The status of the execution of the rule" enum: ["InProgress", "Succeeded", "AlreadyInProgress", "Aborted", "Failed", "Unknown"] } userId: { type: "string" format: "guid" description: "The userId that executed the rule if any" } } } } paginationResult: { type: "object" required: ["entryCount", "links", "pageCount", "totalEntryCount"] properties: { entryCount: { type: "integer" description: "The entry count currently returned" } links: { type: "object" description: "The navigation links 'first', 'last', 'next', 'previous'" required: ["first", "last"] properties: { first: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } last: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } next: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } previous: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } } } pageCount: { type: "integer" description: "The page count" } totalEntryCount: { type: "integer" description: "The total entry count" } } } } } }