Retrieves the list of mainframe files and directories associated with the specified pipeline within a project.
HTML
GET https://hostname/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/filesFeatures
- Complete file and directory metadata retrieval
- File application type classification
- User tracking information (created by, modified by)
- Pipeline and data flow associations
- Directory structure and composition
Use cases
- Browse available files and directories for a pipeline
- Access file and directory metadata for management operations
- List pipeline content structure
Required permissions
replication-pipeline::view
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | string |
Unique identifier of the project. |
| pipelineId | Yes | string |
Unique identifier of the pipeline. |
Response
Response body properties
| Property | Required | Type | Description |
|---|---|---|---|
| id | No | string | Unique identifier of the mainframe file. |
| fileName | No | string | Name of the mainframe file. |
| fileContent | No | string | Base64-encoded content of the mainframe file. |
| uploadedDate | No | string | Date when the file was uploaded. |
| modifiedDate | No | string | Date when the file was last modified. |
| lastModifiedBy | No | string | Username of the last person who modified the file. |
| fileApplicationType | No | string | Application type of the file, for example, ENGINE_SCRIPT or CONFIGURATION. |
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.
[
{
"id": "file-123",
"fileName": "example_script.sh",
"uploadedDate": "2024-01-01T12:00:00Z",
"modifiedDate": "2024-01-02T12:00:00Z",
"lastModifiedBy": "user2@example.com",
"fileApplicationType": "ENGINE_SCRIPT"
},
{
"id": "file-456",
"fileName": "config.properties",
"uploadedDate": "2024-01-03T10:15:00Z",
"modifiedDate": "2024-01-04T14:30:00Z",
"lastModifiedBy": "admin@example.com",
"fileApplicationType": "CONFIGURATION"
}
]{
"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",
"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",
"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",
"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",
"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",
"properties": {
"errorCode": "DI-ADAPTER-MFF-0003"
}
}