Skip to content

Commit 1d1bc33

Browse files
export files TOC
1 parent 65b4d5d commit 1d1bc33

File tree

3 files changed

+32
-28
lines changed

3 files changed

+32
-28
lines changed

articles/healthcare-apis/.openpublishing.redirection.healthcare-apis.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,10 @@
487487
"redirect_url": "/azure/healthcare-apis/dicom/dicom-configure-azure-rbac",
488488
"redirect_document_id": true
489489
},
490+
{ "source_path_from_root": "/articles/healthcare-apis/dicom/export-dicom-files.md",
491+
"redirect_url": "/azure/healthcare-apis/dicom/export-files",
492+
"redirect_document_id": true
493+
},
490494
{
491495
"source_path_from_root": "/articles/healthcare-apis/fhir/configure-azure-rbac-for-fhir.md",
492496
"redirect_url": "/azure/healthcare-apis/configure-azure-rbac",

articles/healthcare-apis/dicom/export-dicom-files.md renamed to articles/healthcare-apis/dicom/export-files.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: Export DICOM files by using the export API of the DICOM service
33
description: This how-to guide explains how to export DICOM files to an Azure Blob Storage account.
44
author: mmitrik
55
ms.service: healthcare-apis
6-
ms.subservice: fhir
6+
ms.subservice: dicom
77
ms.topic: how-to
8-
ms.date: 10/14/2022
8+
ms.date: 10/30/2023
99
ms.author: mmitrik
1010
---
1111

@@ -37,7 +37,7 @@ The first step to export data from the DICOM service is to enable a system-assig
3737

3838
It takes a few minutes to create the system-assigned managed identity. After the system identity is enabled, an **Object (principal) ID** appears.
3939

40-
## Give storage account permissions to the system-assigned managed identity
40+
## Assign storage account permissions
4141

4242
The system-assigned managed identity needs **Storage Blob Data Contributor** permission to write data to the destination storage account.
4343

@@ -67,7 +67,7 @@ Given a *source*, the set of data to be exported, and a *destination*, the locat
6767

6868
Any errors encountered while you attempt to export are recorded in an error log. For more information, see the [Errors](#errors) section.
6969

70-
## Request
70+
#### Request
7171

7272
The request body consists of the export source and destination.
7373

@@ -90,15 +90,15 @@ The request body consists of the export source and destination.
9090
}
9191
```
9292

93-
### Source settings
93+
#### Source settings
9494

9595
The only setting is the list of identifiers to export.
9696

9797
| Property | Required | Default | Description |
9898
| :------- | :------- | :------ | :---------- |
9999
| `Values` | Yes | | A list of one or more DICOM studies, series, and/or SOP instance identifiers in the format of `"<StudyInstanceUID>[/<SeriesInstanceUID>[/<SOPInstanceUID>]]"` |
100100

101-
### Destination settings
101+
#### Destination settings
102102

103103
The connection to the Blob Storage account is specified with `BlobContainerUri`.
104104

@@ -107,7 +107,7 @@ The connection to the Blob Storage account is specified with `BlobContainerUri`.
107107
| `BlobContainerUri` | No | `""` | The complete URI for the blob container |
108108
| `UseManagedIdentity` | Yes | `false` | A required flag that indicates whether managed identity should be used to authenticate to the blob container |
109109

110-
### Example
110+
#### Example
111111

112112
The following example requests the export of the following DICOM resources to the blob container named `export` in the storage account named `dicomexport`:
113113

@@ -140,7 +140,7 @@ Content-Type: application/json
140140
}
141141
```
142142

143-
## Response
143+
#### Response
144144

145145
The export API returns a `202` status code when an export operation is started successfully. The body of the response contains a reference to the operation, while the value of the `Location` header is the URL for the export operation's status (the same as `href` in the body).
146146

@@ -155,7 +155,7 @@ Content-Type: application/json
155155
}
156156
```
157157

158-
### Operation status
158+
#### Operation status
159159

160160
Poll the preceding `href` URL for the current status of the export operation until completion. After the job has reached a terminal state, the API returns a 200 status code instead of 202. The value of its status property is updated accordingly.
161161

@@ -180,7 +180,7 @@ Content-Type: application/json
180180

181181
If there are any user errors when you export a DICOM file, the file is skipped and its corresponding error is logged. This error log is also exported alongside the DICOM files and the caller can review it. You can find the error log at `<export blob container uri>/<operation ID>/errors.log`.
182182

183-
### Format
183+
#### Format
184184

185185
Each line of the error log is a JSON object with the following properties. A given error identifier might appear multiple times in the log as each update to the log is processed *at least once*.
186186

@@ -190,9 +190,4 @@ Each line of the error log is a JSON object with the following properties. A giv
190190
| `Identifier` | The identifier for the DICOM study, series, or SOP instance in the format of `"<study instance UID>[/<series instance UID>[/<SOP instance UID>]]"` |
191191
| `Error` | The detailed error message |
192192

193-
## Next steps
194-
195-
>[!div class="nextstepaction"]
196-
>[Overview of the DICOM service](dicom-services-overview.md)
197-
198193
[!INCLUDE [DICOM trademark statement](../includes/healthcare-apis-dicom-trademark.md)]

articles/healthcare-apis/dicom/toc.yml

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@ items:
33
href: index.yml
44
- name: What is the DICOM service?
55
href: overview.md
6-
- name: Quickstarts
6+
- name: DICOM conformance statements
7+
expanded: false
8+
items:
9+
- name: V2
10+
href: dicom-services-conformance-statement-v2.md
11+
- name: V1
12+
href: dicom-services-conformance-statement.md
13+
- name: Get started
714
expanded: true
815
items:
916
- name: Get started with the DICOM service
@@ -14,28 +21,26 @@ items:
1421
href: get-access-token.md
1522
- name: Register a client application
1623
href: dicom-register-application.md
24+
- name: Tutorials
25+
expanded: true
26+
items:
1727
- name: Use DICOM data in analytics workloads
1828
href: get-started-with-analytics-dicom.md
19-
- name: How-tos
20-
expanded: false
21-
items:
22-
- name: Import DICOM files
23-
href: import-files.md
2429
- name: Use the DICOM service for digital pathology
2530
href: dicom-digital-pathology.md
31+
- name: Configuration & operations
32+
expanded: true
33+
items:
2634
- name: Configure CORS
2735
href: configure-cross-origin-resource-sharing.md
2836
- name: Configure Azure RBAC
2937
href: dicom-configure-azure-rbac.md
3038
- name: Enable audit and diagnostic logging
3139
href: enable-diagnostic-logging.md
32-
- name: DICOM conformance statements
33-
expanded: false
34-
items:
35-
- name: V2
36-
href: dicom-services-conformance-statement-v2.md
37-
- name: V1
38-
href: dicom-services-conformance-statement.md
40+
- name: Import DICOM files
41+
href: import-files.md
42+
- name: Export DICOM files
43+
href: export-files.md
3944
- name: API reference
4045
expanded: true
4146
items:

0 commit comments

Comments
 (0)