Ramp: List attachments on a procurement request
Ramp unifiedRequest.getUnifiedRequestAttachmentsResource: arguments, response, policy and SDK examples.
← Unified request operations · Get started
Operation ramp.get_unified_request_attachments_resource
Provider route: GET /developer/v1/unified-requests/{unified_request_id}/attachments. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["unifiedRequest"]["getUnifiedRequestAttachmentsResource"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.unifiedRequest.getUnifiedRequestAttachmentsResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.unified_request.get_unified_request_attachments_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.unified_request_id | string | Required within parent | Format: uuid |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | |
$[] | Model | Each item | Expand List attachments on a procurement request — response body — item |
Referenced models: List attachments on a procurement request — response body — item
Schemas
Section titled “Schemas”List attachments on a procurement request — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachment_type | string | Required within parent | Type of attachment. PURCHASE_ORDER attachments are included in the purchase order PDF sent to the vendor; SPEND_REQUEST attachments are supporting documents on the request. Known values: PURCHASE_ORDER, SPEND_REQUEST |
created_at | string | Required within parent | Time at which the attachment was uploaded. Format: date-time |
download_url | JSON | Required within parent | |
download_url (anyOf 1) | string | Alternative | Pre-signed URL to download the attachment. Valid for 1 hour. Read only: true |
download_url (anyOf 2) | null | Alternative | |
filename | string | Required within parent | Original filename of the uploaded attachment. Read only: true |
id | string | Required within parent | Unique identifier of the attachment. Format: uuid |
source | string | Required within parent | Where the attachment originated from. Known values: DEVELOPER_API, DOCUSIGN, IRONCLAD, RAMP |
unified_request_id | string | Required within parent | Unique identifier of the request this attachment belongs to. Format: uuid Read only: true |
uploaded_by_user_id | JSON | Required within parent | |
uploaded_by_user_id (anyOf 1) | string | Alternative | Unique identifier of the user who uploaded the attachment. Format: uuid |
uploaded_by_user_id (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_unified_request_attachments_resource. Catalog operation: get_unified_request_attachments_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["unified_requests:read"]