How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Health Data Services Jobs API

The Jobs API from Microsoft Azure Health Data Services — 4 operation(s) for jobs.

Microsoft Azure Health Data Services Jobs API is one of 13 APIs that Microsoft Azure Health Data Services publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a changelog, and pricing.

This API exposes 6 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 2024-11-15.

Requests are made against the base URL https://{workspace-name}-{fhir-service-name}.fhir.azurehealthcareapis.com.

6 operations 4 paths 14 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2024-11-15
Base URL
https://{workspace-name}-{fhir-service-name}.fhir.azurehealthcareapis.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Microsoft Azure Health Data Services Jobs API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (AadToken) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

  • AadToken — The Azure Active Directory OAuth2 Flow

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Jobs 6
GET
/jobs
List de-identification jobs.
ListJobs 4 params → 200default
GET
/jobs/{name}
Get a de-identification job.
GetJob 3 params → 200default
PUT
/jobs/{name}
Create a de-identification job.
DeidentifyDocuments 3 params body → 200201default
DELETE
/jobs/{name}
Delete a de-identification job.
DeleteJob 3 params → 204default
POST
/jobs/{name}:cancel
Cancel a de-identification job.
CancelJob 3 params → 200default
GET
/jobs/{name}/documents
List processed documents within a job.
ListJobDocuments 5 params → 200default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are DeidentificationJob (11 properties), DeidentificationDocumentDetails (5 properties), Azure.Core.Foundations.Error (5 properties), DeidentificationJobSummary (5 properties). Each schema is shown below with its type and property counts.

Azure.Core.Foundations.OperationState
string
Enum describing allowed operation states.
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelineshandling-errors.
2 properties
DeidentificationDocumentDetails
object
Details of a single document in a job.
5 properties 3 required
DeidentificationJob
object
A job containing a batch of documents to de-identify.
11 properties 6 required
PagedDeidentificationDocumentDetails
object
Paged collection of DeidentificationDocumentDetails items
2 properties 1 required
DeidentificationDocumentLocation
object
Location of a document.
2 properties 2 required
DeidentificationJobSummary
object
Summary metrics of a job.
5 properties 5 required
TargetStorageLocation
object
Storage location.
3 properties 2 required
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property 1 required
Azure.Core.eTag
string
The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a…
SourceStorageLocation
object
Storage location.
3 properties 2 required
Azure.Core.Foundations.Error
object
The error object.
5 properties 2 required
DeidentificationJobCustomizationOptions
object
Customizations options to override default service behaviors for job usage.
2 properties
PagedDeidentificationJob
object
Paged collection of DeidentificationJob items
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

azure-health-jobs-api-openapi.yml Raw ↑

Other APIs Microsoft Azure Health Data Services publishes across the network.

Microsoft Azure Health Data Services Collection API
Microsoft Azure Health Data Services Deid API
Microsoft Azure Health Data Services DicomServices API
Microsoft Azure Health Data Services FhirServices API
Microsoft Azure Health Data Services IotConnectors API
Microsoft Azure Health Data Services PrivateEndpointConnections API
Microsoft Azure Health Data Services PrivateLinkResources API
Microsoft Azure Health Data Services Proxy API
Microsoft Azure Health Data Services Resource API
Microsoft Azure Health Data Services WorkspacePrivateEndpointConnections API
Microsoft Azure Health Data Services WorkspacePrivateLinkResources API
Microsoft Azure Health Data Services Workspaces API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Health Data Services Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.