Xeonr Developer Docs
UplApiuplim.api.v1.InternalPipelineRunsService

Get Active Pipeline For Resource

POST
/uplim.api.v1.InternalPipelineRunsService/GetActivePipelineForResource

Resolves the integration from the content-type URN's slug prefix and returns its PUBLISHED pipeline for the URN and resource kind, plus the snapshot for the current version and the resolved integration id. Returns an empty response (no error) when the slug matches no integration, no pipeline exists, it isn't published, or its snapshot is missing. A URN without a <slug>: prefix is rejected with InvalidArgument.

Access: internal only — the pipeline coordinator, authenticated by the shared X-Upl-Internal-Token header matching PIPELINE_INTERNAL_TOKEN (FailedPrecondition when unset, Unauthenticated on mismatch). No user authentication.

Authorization

AuthorizationBearer <token>

JWT access token obtained via OAuth2 flow or service account

In: header

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

contentTypeUrn?string

Fully-qualified content type URN (":" for integration-owned, "default:" for system defaults). The server derives integration_id from the slug prefix — callers in upl-im-pipeline don't carry integration_id through the workflow.

Length1 <= length
resourceKind?string
Value in"PIPELINE_RESOURCE_KIND_UNSPECIFIED" | "PIPELINE_RESOURCE_KIND_UPLOAD" | "PIPELINE_RESOURCE_KIND_FOLDER" | "PIPELINE_RESOURCE_KIND_VIRTUAL_FILE" | "PIPELINE_RESOURCE_KIND_INTEGRATION_FOLDER"
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.InternalPipelineRunsService/GetActivePipelineForResource" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "pipeline": {
    "id": "string",
    "integrationId": "string",
    "contentTypeUrn": "string",
    "resourceKind": "PIPELINE_RESOURCE_KIND_UNSPECIFIED",
    "version": 0,
    "status": "PIPELINE_STATUS_UNSPECIFIED",
    "steps": [
      {
        "stepId": "string",
        "kind": "PIPELINE_STEP_KIND_UNSPECIFIED",
        "exec": {
          "ref": "string",
          "inputs": {
            "property1": "string",
            "property2": "string"
          },
          "configJson": "string",
          "outputs": [
            {
              "slot": "string",
              "required": true,
              "blob": {
                "name": "string",
                "mimeHint": "string",
                "maxSizeBytes": "string"
              }
            }
          ],
          "secrets": [
            {
              "name": "string",
              "from": "string"
            }
          ]
        }
      }
    ],
    "policy": {
      "maxRetriesPerStep": 5,
      "stepTimeoutSec": 1,
      "pipelineTimeoutSec": 0
    },
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z",
    "publishedAt": "2023-01-15T01:30:15.01Z"
  },
  "snapshot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",
    "pipelineVersion": 0,
    "pipeline": {
      "id": "string",
      "integrationId": "string",
      "contentTypeUrn": "string",
      "resourceKind": "PIPELINE_RESOURCE_KIND_UNSPECIFIED",
      "version": 0,
      "status": "PIPELINE_STATUS_UNSPECIFIED",
      "steps": [
        {
          "stepId": "string",
          "kind": "PIPELINE_STEP_KIND_UNSPECIFIED",
          "exec": {
            "ref": "string",
            "inputs": {
              "property1": "string",
              "property2": "string"
            },
            "configJson": "string",
            "outputs": [
              {
                "slot": "string",
                "required": true,
                "blob": {
                  "name": "string",
                  "mimeHint": "string",
                  "maxSizeBytes": "string"
                }
              }
            ],
            "secrets": [
              {
                "name": "string",
                "from": "string"
              }
            ]
          }
        }
      ],
      "policy": {
        "maxRetriesPerStep": 5,
        "stepTimeoutSec": 1,
        "pipelineTimeoutSec": 0
      },
      "createdAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z",
      "publishedAt": "2023-01-15T01:30:15.01Z"
    },
    "stepManifests": {
      "property1": {
        "name": "string",
        "version": "string",
        "kind": "PIPELINE_STEP_KIND_UNSPECIFIED",
        "kinds": [
          "PIPELINE_RESOURCE_KIND_UNSPECIFIED"
        ],
        "inputs": [
          {
            "name": "string",
            "schemaJson": "string",
            "required": true,
            "isBlob": true
          }
        ],
        "outputs": {
          "blobs": [
            {
              "name": "string",
              "required": true,
              "envelopeSchemaJson": "string",
              "mimeHint": "string",
              "maxSizeBytes": "string"
            }
          ],
          "kv": [
            {
              "name": "string",
              "required": true,
              "valueType": "METADATA_VALUE_TYPE_UNSPECIFIED"
            }
          ],
          "locals": [
            {
              "name": "string",
              "required": true,
              "valueType": "METADATA_VALUE_TYPE_UNSPECIFIED"
            }
          ],
          "localBlobs": [
            {
              "name": "string",
              "required": true,
              "mimeHint": "string"
            }
          ]
        },
        "requiredSecrets": [
          "string"
        ],
        "configSchemaJson": "string",
        "runtimeVersion": "string",
        "description": "string",
        "readmeMd": "string",
        "rendererRef": {
          "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
          "contentTypeUrn": "string",
          "entry": "string"
        },
        "exec": {
          "image": "string",
          "imageDigest": "string",
          "command": [
            "string"
          ],
          "args": [
            "string"
          ]
        },
        "bundleSha256": "string"
      },
      "property2": {
        "name": "string",
        "version": "string",
        "kind": "PIPELINE_STEP_KIND_UNSPECIFIED",
        "kinds": [
          "PIPELINE_RESOURCE_KIND_UNSPECIFIED"
        ],
        "inputs": [
          {
            "name": "string",
            "schemaJson": "string",
            "required": true,
            "isBlob": true
          }
        ],
        "outputs": {
          "blobs": [
            {
              "name": "string",
              "required": true,
              "envelopeSchemaJson": "string",
              "mimeHint": "string",
              "maxSizeBytes": "string"
            }
          ],
          "kv": [
            {
              "name": "string",
              "required": true,
              "valueType": "METADATA_VALUE_TYPE_UNSPECIFIED"
            }
          ],
          "locals": [
            {
              "name": "string",
              "required": true,
              "valueType": "METADATA_VALUE_TYPE_UNSPECIFIED"
            }
          ],
          "localBlobs": [
            {
              "name": "string",
              "required": true,
              "mimeHint": "string"
            }
          ]
        },
        "requiredSecrets": [
          "string"
        ],
        "configSchemaJson": "string",
        "runtimeVersion": "string",
        "description": "string",
        "readmeMd": "string",
        "rendererRef": {
          "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
          "contentTypeUrn": "string",
          "entry": "string"
        },
        "exec": {
          "image": "string",
          "imageDigest": "string",
          "command": [
            "string"
          ],
          "args": [
            "string"
          ]
        },
        "bundleSha256": "string"
      }
    },
    "createdAt": "2023-01-15T01:30:15.01Z"
  },
  "resolvedIntegrationId": "string"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}