StructuredDataFormat

Create a Structured Data Format for XML/JSON masking.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The parameters to create a structuredDataFormat.

file_upload_ref
string

ID of uploaded XML/JSON format file for further use.

doc_type
string

The type of structured document.

Enum: "XML" "JSON"
required
Array of objects (StructuredFieldMetaData)

Array of objects consisting of the details for the path and algorithm for the fields to be masked)

Responses
201

Created

400

Invalid Input provided.

500

Internal Service Unavailable.

post/structured-data-format
Request samples
application/json
{
  • "file_upload_ref": "delphix-file://upload/f_XXXX/XXX.xml",
  • "doc_type": "XML",
  • "masking_inventory_paths": [
    ]
}
Response samples
application/json
{
  • "file_upload_ref": "delphix-file://upload/f_XXXX/XXX.xml",
  • "doc_type": "XML",
  • "masking_inventory_paths": [
    ]
}

Returns a list of Structured Data Formats.

SecurityApiKeyAuth
Responses
200

OK

500

Internal Service Unavailable.

get/structured-data-format
Response samples
application/json
[
  • {
    }
]

Returns a structured data format info by ID.

SecurityApiKeyAuth
Request
path Parameters
structuredDataFormatId
required
integer <int64> >= 1

Numeric ID of the structured data format.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

get/structured-data-format/{structuredDataFormatId}
Response samples
application/json
{
  • "file_upload_ref": "delphix-file://upload/f_XXXX/XXX.xml",
  • "doc_type": "XML",
  • "masking_inventory_paths": [
    ]
}

Update an existing structured data format.

SecurityApiKeyAuth
Request
path Parameters
structuredDataFormatId
required
integer <int64> >= 1

Numeric ID of the structured data format.

Request Body schema: application/json
required

The updated structured data format information.

file_upload_ref
string

ID of uploaded XML/JSON format file for further use.

doc_type
string

The type of structured document.

Enum: "XML" "JSON"
required
Array of objects (StructuredFieldMetaData)

Array of objects consisting of the details for the path and algorithm for the fields to be masked)

Responses
200

OK

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

put/structured-data-format/{structuredDataFormatId}
Request samples
application/json
{
  • "file_upload_ref": "delphix-file://upload/f_XXXX/XXX.xml",
  • "doc_type": "XML",
  • "masking_inventory_paths": [
    ]
}
Response samples
application/json
{
  • "file_upload_ref": "delphix-file://upload/f_XXXX/XXX.xml",
  • "doc_type": "XML",
  • "masking_inventory_paths": [
    ]
}

Delete an existing structured data format.

SecurityApiKeyAuth
Request
path Parameters
structuredDataFormatId
required
integer <int64> >= 1

Numeric ID of the structured data format.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

delete/structured-data-format/{structuredDataFormatId}
➔ Next to DataSets