> ## Documentation Index > Fetch the complete documentation index at: https://apidocs.specurate.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Xlsx ## OpenAPI ````yaml /openapi.json post /v1/workspaces/{workspaceId}/report-generations/xlsx openapi: 3.1.0 info: title: Specurate API description: '' version: 1.0.0 contact: {} servers: - url: https://app.specurate.com/api description: API Server security: [] tags: [] paths: /v1/workspaces/{workspaceId}/report-generations/xlsx: post: tags: - Report Generations summary: Create Xlsx operationId: ReportGenerationsController_createXlsx_v1 parameters: - name: workspaceId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateReportXlsxExportDto' responses: '201': description: '' content: application/json: schema: type: object components: schemas: CreateReportXlsxExportDto: oneOf: - type: object properties: projectId: type: string minLength: 1 scope: oneOf: - type: object properties: mode: type: string const: explicit slotIds: minItems: 1 maxItems: 2500 type: array items: type: string required: - mode - slotIds additionalProperties: false - type: object properties: mode: type: string const: query filters: default: {} type: object properties: categoryIds: maxItems: 100 type: array items: type: string minLength: 1 status: type: string enum: - new - ready - updates - broken filter: type: object propertyNames: type: string minLength: 1 maxLength: 120 additionalProperties: type: object properties: value: anyOf: - type: string maxLength: 1000 - type: number - type: boolean values: maxItems: 100 type: array items: type: string maxLength: 255 min: type: number max: type: number from: type: string to: type: string mode: type: string enum: - contains - equals additionalProperties: false additionalProperties: false sort: default: [] maxItems: 1 type: array items: type: object properties: field: type: string enum: - position - createdAt - updatedAt direction: type: string enum: - asc - desc required: - field - direction additionalProperties: false required: - mode additionalProperties: false - type: object properties: configuration: type: object properties: schemaVersion: type: number const: 1 columns: maxItems: 200 type: array items: type: string minLength: 1 maxLength: 255 quickFilters: type: object properties: status: maxItems: 20 type: array items: type: string minLength: 1 maxLength: 255 categoryIds: maxItems: 100 type: array items: type: string minLength: 1 maxLength: 255 columnFilters: maxItems: 50 type: array items: oneOf: - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 type: type: string const: text value: type: string minLength: 1 maxLength: 1000 mode: type: string enum: - contains - equals required: - fieldKey - type - value - mode additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 type: type: string const: number min: type: number max: type: number required: - fieldKey - type additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 type: type: string const: boolean value: type: boolean required: - fieldKey - type - value additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 type: type: string const: list values: minItems: 1 maxItems: 100 type: array items: type: string minLength: 1 maxLength: 255 required: - fieldKey - type - values additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 type: type: string const: date from: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ to: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - fieldKey - type additionalProperties: false required: - status - categoryIds - columnFilters additionalProperties: false advancedFilter: type: object properties: sets: maxItems: 5 type: array items: type: object properties: conditions: minItems: 1 maxItems: 10 type: array items: oneOf: - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 operator: type: string enum: - is_any_of - is_not_any_of values: minItems: 1 maxItems: 100 type: array items: type: string minLength: 1 maxLength: 255 required: - fieldKey - operator - values additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 operator: type: string enum: - contains - does_not_contain value: type: string minLength: 1 maxLength: 1000 required: - fieldKey - operator - value additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 operator: type: string enum: - is_empty - is_not_empty required: - fieldKey - operator additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 operator: type: string enum: - date_on - date_before - date_after value: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - fieldKey - operator - value additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 operator: type: string const: date_between from: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ to: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - fieldKey - operator - from - to additionalProperties: false required: - conditions additionalProperties: false required: - sets additionalProperties: false groupBy: maxItems: 2 type: array items: type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 direction: type: string enum: - asc - desc required: - fieldKey - direction additionalProperties: false sort: maxItems: 1 type: array items: type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 direction: type: string enum: - asc - desc required: - fieldKey - direction additionalProperties: false required: - schemaVersion - columns - quickFilters - advancedFilter - groupBy - sort additionalProperties: false search: type: string minLength: 1 maxLength: 255 status: type: string enum: - new - ready - broken navigatorScope: oneOf: - type: object properties: kind: type: string const: area areaId: type: string scope: default: subtree type: string enum: - direct - subtree required: - kind - areaId additionalProperties: false - type: object properties: kind: type: string const: category categoryId: type: string required: - kind - categoryId additionalProperties: false - type: object properties: kind: type: string const: special value: type: string enum: - unassigned - extra required: - kind - value additionalProperties: false - type: object properties: kind: type: string const: path segments: minItems: 1 maxItems: 10 type: array items: oneOf: - type: object properties: dimension: type: string const: area areaId: type: string scope: type: string enum: - direct - subtree required: - dimension - areaId - scope additionalProperties: false - type: object properties: dimension: type: string const: area-type areaTypeKey: anyOf: - type: string pattern: ^[a-f0-9]{64}$ - type: 'null' required: - dimension - areaTypeKey additionalProperties: false - type: object properties: dimension: type: string const: area-level levelKey: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ areaId: anyOf: - type: string - type: 'null' required: - dimension - levelKey - areaId additionalProperties: false - type: object properties: dimension: type: string const: category categoryId: type: string required: - dimension - categoryId additionalProperties: false - type: object properties: dimension: type: string const: status status: type: string enum: - new - ready - broken required: - dimension - status additionalProperties: false - type: object properties: dimension: type: string const: supplier supplierId: anyOf: - type: string - type: 'null' required: - dimension - supplierId additionalProperties: false - type: object properties: dimension: type: string const: finish valueKey: anyOf: - type: string pattern: ^[a-f0-9]{64}$ - type: 'null' required: - dimension - valueKey additionalProperties: false - type: object properties: dimension: type: string const: field field: type: string maxLength: 200 pattern: >- ^(?:system|catalog_family|catalog_item|catalog_family_source|catalog_item_source|project_item|project_item_slot):[a-zA-Z0-9_-]+$ value: anyOf: - type: string minLength: 1 maxLength: 1000 - type: 'null' required: - dimension - field - value additionalProperties: false required: - kind - segments additionalProperties: false changedSinceIssue: type: boolean changedInRange: type: object properties: from: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ to: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ timeZone: default: UTC type: string minLength: 1 maxLength: 64 required: - from - to additionalProperties: false selection: type: object properties: schemaVersion: type: number const: 1 defaultSelected: type: boolean groupOverrides: maxItems: 500 type: array items: type: object properties: path: minItems: 1 maxItems: 2 type: array items: type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 valueKey: anyOf: - type: string minLength: 1 maxLength: 1000 - type: 'null' required: - fieldKey - valueKey additionalProperties: false selected: type: boolean required: - path - selected additionalProperties: false slotOverrides: maxItems: 500 type: array items: type: object properties: slotId: type: string selected: type: boolean required: - slotId - selected additionalProperties: false required: - schemaVersion - defaultSelected - groupOverrides - slotOverrides additionalProperties: false mode: type: string const: table_query required: - configuration - mode additionalProperties: false locale: default: en type: string enum: - en - es - zh - ja - fr - de format: type: string const: product_table columns: minItems: 1 maxItems: 100 type: array items: type: object properties: key: type: string minLength: 1 maxLength: 200 label: type: string minLength: 1 maxLength: 200 required: - key - label additionalProperties: false options: type: object properties: versionLabel: anyOf: - type: string maxLength: 40 - type: 'null' rowPerArea: type: boolean includeUnallocated: type: boolean required: - versionLabel - rowPerArea - includeUnallocated additionalProperties: false required: - projectId - scope - format - columns - options additionalProperties: false - type: object properties: projectId: type: string minLength: 1 scope: oneOf: - type: object properties: mode: type: string const: explicit slotIds: minItems: 1 maxItems: 2500 type: array items: type: string required: - mode - slotIds additionalProperties: false - type: object properties: mode: type: string const: query filters: default: {} type: object properties: categoryIds: maxItems: 100 type: array items: type: string minLength: 1 status: type: string enum: - new - ready - updates - broken filter: type: object propertyNames: type: string minLength: 1 maxLength: 120 additionalProperties: type: object properties: value: anyOf: - type: string maxLength: 1000 - type: number - type: boolean values: maxItems: 100 type: array items: type: string maxLength: 255 min: type: number max: type: number from: type: string to: type: string mode: type: string enum: - contains - equals additionalProperties: false additionalProperties: false sort: default: [] maxItems: 1 type: array items: type: object properties: field: type: string enum: - position - createdAt - updatedAt direction: type: string enum: - asc - desc required: - field - direction additionalProperties: false required: - mode additionalProperties: false - type: object properties: configuration: type: object properties: schemaVersion: type: number const: 1 columns: maxItems: 200 type: array items: type: string minLength: 1 maxLength: 255 quickFilters: type: object properties: status: maxItems: 20 type: array items: type: string minLength: 1 maxLength: 255 categoryIds: maxItems: 100 type: array items: type: string minLength: 1 maxLength: 255 columnFilters: maxItems: 50 type: array items: oneOf: - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 type: type: string const: text value: type: string minLength: 1 maxLength: 1000 mode: type: string enum: - contains - equals required: - fieldKey - type - value - mode additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 type: type: string const: number min: type: number max: type: number required: - fieldKey - type additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 type: type: string const: boolean value: type: boolean required: - fieldKey - type - value additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 type: type: string const: list values: minItems: 1 maxItems: 100 type: array items: type: string minLength: 1 maxLength: 255 required: - fieldKey - type - values additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 type: type: string const: date from: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ to: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - fieldKey - type additionalProperties: false required: - status - categoryIds - columnFilters additionalProperties: false advancedFilter: type: object properties: sets: maxItems: 5 type: array items: type: object properties: conditions: minItems: 1 maxItems: 10 type: array items: oneOf: - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 operator: type: string enum: - is_any_of - is_not_any_of values: minItems: 1 maxItems: 100 type: array items: type: string minLength: 1 maxLength: 255 required: - fieldKey - operator - values additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 operator: type: string enum: - contains - does_not_contain value: type: string minLength: 1 maxLength: 1000 required: - fieldKey - operator - value additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 operator: type: string enum: - is_empty - is_not_empty required: - fieldKey - operator additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 operator: type: string enum: - date_on - date_before - date_after value: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - fieldKey - operator - value additionalProperties: false - type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 operator: type: string const: date_between from: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ to: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - fieldKey - operator - from - to additionalProperties: false required: - conditions additionalProperties: false required: - sets additionalProperties: false groupBy: maxItems: 2 type: array items: type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 direction: type: string enum: - asc - desc required: - fieldKey - direction additionalProperties: false sort: maxItems: 1 type: array items: type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 direction: type: string enum: - asc - desc required: - fieldKey - direction additionalProperties: false required: - schemaVersion - columns - quickFilters - advancedFilter - groupBy - sort additionalProperties: false search: type: string minLength: 1 maxLength: 255 status: type: string enum: - new - ready - broken navigatorScope: oneOf: - type: object properties: kind: type: string const: area areaId: type: string scope: default: subtree type: string enum: - direct - subtree required: - kind - areaId additionalProperties: false - type: object properties: kind: type: string const: category categoryId: type: string required: - kind - categoryId additionalProperties: false - type: object properties: kind: type: string const: special value: type: string enum: - unassigned - extra required: - kind - value additionalProperties: false - type: object properties: kind: type: string const: path segments: minItems: 1 maxItems: 10 type: array items: oneOf: - type: object properties: dimension: type: string const: area areaId: type: string scope: type: string enum: - direct - subtree required: - dimension - areaId - scope additionalProperties: false - type: object properties: dimension: type: string const: area-type areaTypeKey: anyOf: - type: string pattern: ^[a-f0-9]{64}$ - type: 'null' required: - dimension - areaTypeKey additionalProperties: false - type: object properties: dimension: type: string const: area-level levelKey: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ areaId: anyOf: - type: string - type: 'null' required: - dimension - levelKey - areaId additionalProperties: false - type: object properties: dimension: type: string const: category categoryId: type: string required: - dimension - categoryId additionalProperties: false - type: object properties: dimension: type: string const: status status: type: string enum: - new - ready - broken required: - dimension - status additionalProperties: false - type: object properties: dimension: type: string const: supplier supplierId: anyOf: - type: string - type: 'null' required: - dimension - supplierId additionalProperties: false - type: object properties: dimension: type: string const: finish valueKey: anyOf: - type: string pattern: ^[a-f0-9]{64}$ - type: 'null' required: - dimension - valueKey additionalProperties: false - type: object properties: dimension: type: string const: field field: type: string maxLength: 200 pattern: >- ^(?:system|catalog_family|catalog_item|catalog_family_source|catalog_item_source|project_item|project_item_slot):[a-zA-Z0-9_-]+$ value: anyOf: - type: string minLength: 1 maxLength: 1000 - type: 'null' required: - dimension - field - value additionalProperties: false required: - kind - segments additionalProperties: false changedSinceIssue: type: boolean changedInRange: type: object properties: from: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ to: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ timeZone: default: UTC type: string minLength: 1 maxLength: 64 required: - from - to additionalProperties: false selection: type: object properties: schemaVersion: type: number const: 1 defaultSelected: type: boolean groupOverrides: maxItems: 500 type: array items: type: object properties: path: minItems: 1 maxItems: 2 type: array items: type: object properties: fieldKey: type: string minLength: 1 maxLength: 255 valueKey: anyOf: - type: string minLength: 1 maxLength: 1000 - type: 'null' required: - fieldKey - valueKey additionalProperties: false selected: type: boolean required: - path - selected additionalProperties: false slotOverrides: maxItems: 500 type: array items: type: object properties: slotId: type: string selected: type: boolean required: - slotId - selected additionalProperties: false required: - schemaVersion - defaultSelected - groupOverrides - slotOverrides additionalProperties: false mode: type: string const: table_query required: - configuration - mode additionalProperties: false locale: default: en type: string enum: - en - es - zh - ja - fr - de format: type: string const: quantity_matrix columns: minItems: 2 maxItems: 2 type: array items: type: object properties: key: type: string minLength: 1 maxLength: 200 label: type: string minLength: 1 maxLength: 200 required: - key - label additionalProperties: false options: type: object properties: versionLabel: anyOf: - type: string maxLength: 40 - type: 'null' required: - versionLabel additionalProperties: false required: - projectId - scope - format - columns - options additionalProperties: false ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.