Update mainframe file content by ID - Precisely Data Integrity Suite

Data Integrity Suite APIs

Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Updates the content of an existing mainframe file by its unique file ID with new file content.

HTML

PUT https://hostname/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}

Process overview

  1. Request Validation—Validates file ID and multipart file content.
  2. File Content Update—Updates the file with new multipart content.

Key features

  • Replace entire file content in a single operation.
  • Preserves file metadata and timestamps.

Use cases

  • Update script content from file.
  • Modify configuration files with new versions.
  • Replace file content without recreating.

Required permissions

replication-pipeline::manage

Request

Path parameters

Key Required Type Description
projectId Yes string

Unique identifier of the project.

Example: project-123
pipelineId Yes string

Unique identifier of the pipeline.

Example: pipeline-456
fileId Yes string

Unique identifier of the file to update.

Example: file-789

Request body properties

Property Required Type Description
file Yes string File content in binary format.

Response

Response body examples

Example status code responses for this method are shown here. To view the response schemas, you can download the Data Integration API specification (Precisely Integration Adapter Service) from the Precisely Developer Portal.

Examples
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "Validation error occurred",
  "instance": "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}",
  "properties": {
    "errorCode": "DI-ADAPTER-VAL-0000"
  }
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authorization failed - missing or invalid credentials",
  "instance": "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}",
  "properties": {
    "errorCode": "DI-ADAPTER-AUT-0001"
  }
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.4",
  "title": "Forbidden",
  "status": 403,
  "detail": "Authorization failed - insufficient permissions",
  "instance": "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}",
  "properties": {
    "errorCode": "DI-ADAPTER-AUT-0002"
  }
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.5",
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found - Resource does not exist",
  "instance": "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}",
  "properties": {
    "errorCode": "DI-ADAPTER-MFF-0004"
  }
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.6",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred",
  "instance": "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/files/{fileId}",
  "properties": {
    "errorCode": "DI-ADAPTER-MFF-0008"
  }
}