> ## Documentation Index > Fetch the complete documentation index at: https://integration.delogue.com/llms.txt > Use this file to discover all available pages before exploring further. # Get the organization's per-entity D2 migration progress > Returns the overall lifecycle status plus one row per ETL entity domain (styles, items, sampleRequest, customFields, bom, workflow) in run order, including domains not yet attempted (status=pending). currentDomain is the domain currently running, or the one that failed, or null. Backs the migration-preview page. ## OpenAPI ````yaml https://service.my.delogue.com/openapi/external.json get /api/organizations/{organizationId}/migration-progress openapi: 3.1.1 info: title: Delogue External API - (Production) description: Integration endpoints for Delogue API version: 1.0.0 servers: - url: / description: The Delogue environment serving this document. - url: https://{host} description: Per-customer Delogue API host. variables: host: default: service.my.delogue.com description: >- The API host for your Delogue environment, e.g. service..delogue.com. security: [] tags: - name: Barcodes - name: Brands - name: CareInstructionIcons - name: CareInstructionLayers - name: CareInstructionMaterials - name: CareInstructions - name: Color Groups - name: Colors - name: ComplianceCategories - name: ComplianceCustomFields - name: Facilities - name: Groups - name: ItemCategories - name: Items - name: MeasurementCharts - name: MigrationApproval - name: MigrationVerification - name: OrganizationMigration - name: Organizations - name: SampleRequests - name: SampleTypes - name: Seasons - name: SizeRanges - name: Style Prices - name: StyleCareInstructions - name: StyleCategories - name: StyleColors - name: StyleContacts - name: StyleCustomFields - name: StyleFiles - name: StyleItems - name: StyleRelations - name: Styles - name: StyleSkus - name: StyleSupplierFacilities - name: SubSuppliers - name: Suppliers paths: /api/organizations/{organizationId}/migration-progress: get: tags: - OrganizationMigration summary: Get the organization's per-entity D2 migration progress description: >- Returns the overall lifecycle status plus one row per ETL entity domain (styles, items, sampleRequest, customFields, bom, workflow) in run order, including domains not yet attempted (status=pending). currentDomain is the domain currently running, or the one that failed, or null. Backs the migration-preview page. operationId: OrganizationMigration_GetProgress parameters: - name: organizationId in: path description: Identifier of the organization whose migration progress to return. required: true schema: pattern: ^-?(?:0|[1-9]\d*)$ type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ApiResponseOfMigrationProgressDto' '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/ApiErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '500': description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/ApiErrorResponse' security: - {} components: schemas: ApiResponseOfMigrationProgressDto: required: - status - code - data type: object properties: status: $ref: '#/components/schemas/ApiResponseStatus' description: >- The coarse outcome of the request, indicating whether it succeeded or failed. code: type: string description: >- The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire. data: oneOf: - type: 'null' - $ref: '#/components/schemas/MigrationProgressDto' description: >- The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value. description: >- The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value. additionalProperties: false ApiErrorResponse: type: object properties: status: $ref: '#/components/schemas/ApiResponseStatus' description: >- The coarse outcome of the request, indicating whether it succeeded or failed. code: type: string description: >- The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire. error: $ref: '#/components/schemas/ErrorWrapper' description: >- The error payload, present instead of data on a failed response. It wraps the list of detail rows describing what went wrong. additionalProperties: false ApiResponseStatus: enum: - success - error type: string description: >- The coarse outcome of the request, indicating whether it succeeded or failed. MigrationProgressDto: type: object properties: organizationId: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: >- Identifier of the organization whose migration progress this describes. format: int32 status: $ref: '#/components/schemas/MigrationRequestStatus' description: >- The overall lifecycle status of the organization's migration, in the shared migration status vocabulary. properties: type: array items: type: string description: >- Zero or more flags that are currently true of the migration, such as needs-reschedule, as an additive string array rather than one boolean per flag. requestedRunAtUtc: type: - 'null' - string description: >- The UTC run time the organization requested, or null when none has been requested. format: date-time scheduledRunAtUtc: type: - 'null' - string description: >- The UTC slot the run was armed for, or null before it has been scheduled. format: date-time runStartedAtUtc: type: - 'null' - string description: >- UTC time the current or most recent run started, or null before any run has begun. format: date-time runCompletedAtUtc: type: - 'null' - string description: >- UTC time the current or most recent run finished, or null while a run is in progress or none has completed. format: date-time failureReason: type: - 'null' - string description: >- The recorded reason the run stopped, present when the migration has failed. currentDomain: oneOf: - type: 'null' - $ref: '#/components/schemas/MigrationEtlDomain' description: >- The entity domain currently being migrated, or the one that failed when the run has stopped. Null when nothing is in flight and nothing has failed. description: >- The entity domain currently being migrated, or the one that failed when the run has stopped. Null when nothing is in flight and nothing has failed. completedDomainCount: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: The number of entity domains that have finished migrating. format: int32 totalDomainCount: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: The total number of entity domains in the migration. format: int32 domains: type: array items: $ref: '#/components/schemas/MigrationDomainProgressDto' description: One progress row per entity domain in the migration. additionalProperties: false description: >- The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value. ErrorWrapper: type: object properties: details: type: array items: $ref: '#/components/schemas/ErrorDetailDto' description: >- The list of individual error detail rows for this failure, one per field or rule that failed. additionalProperties: false description: >- The error payload, present instead of data on a failed response. It wraps the list of detail rows describing what went wrong. MigrationRequestStatus: enum: - legacy - requested - csApproved - techApproved - scheduled - running - completed - confirmed - rejected - failed type: string description: >- The current lifecycle status of the organization's migration request, in the shared migration status vocabulary. MigrationEtlDomain: enum: - styles - items - customFields - bom - workflow - styleAssortment - styleUnitPrice - miscDependents type: string description: >- The entity domain currently being migrated, or the one that failed when the run has stopped. Null when nothing is in flight and nothing has failed. MigrationDomainProgressDto: type: object properties: domain: $ref: '#/components/schemas/MigrationEtlDomain' description: The entity domain this step covers, such as styles or items. status: $ref: '#/components/schemas/MigrationDomainStateDto' description: >- This domain's step status. Pending means it has never been attempted for the organization; otherwise it is running, completed, or failed. startedAtUtc: type: - 'null' - string description: UTC time this domain's step started, or null before it has begun. format: date-time completedAtUtc: type: - 'null' - string description: >- UTC time this domain's step finished, or null while it is running or has not started. format: date-time rowsAffected: type: integer description: The number of rows migrated for this domain in its latest run. format: int64 blockingExceptionCount: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: >- The number of blocking exceptions recorded for this domain; any of them stops the run. format: int32 failureNote: type: - 'null' - string description: >- The migration's own note for this domain's latest run. On a failure it names the phase that failed and the error encountered. additionalProperties: false ErrorDetailDto: required: - type - field - value type: object properties: type: type: string description: >- The hierarchical error code identifying the specific failure, such as validation_error.required_field. Consumers branch on this rather than on the message text. field: type: - 'null' - string description: >- The input field that caused the failure. Omitted when no specific field is at fault, such as an authorization denial or a server error. value: type: - 'null' - string description: >- A human-readable message describing the failure, or the offending value or limit that triggered it. additionalProperties: false MigrationDomainStateDto: enum: - pending - running - completed - failed type: string description: >- This domain's step status. Pending means it has never been attempted for the organization; otherwise it is running, completed, or failed. ````