The enrollmentAttachment object provides the ability to upload an enrollment attachment (via file upload or license key) to the enrollment object.
This object contains the following attributes:
id
string
The primary identifier of the attachment.
Example: ATT-0001-0001-0001-001
href
string
A reference to attachment within the API.
name
string
The name of the attachment object.
Example: Guide to establishing a reseller relationship
description
string
The description of the attachment object.
Example: Learn what happens when you establish a reseller relationship with SoftwareOne
type
string
The type of the attachment object.
Example: File
reference
string
The URI to access the attachment object.
Example: microsoft-agreement-certification.pdf
order
order
Example:
audit
A reference to the audit object.
{
"id": "ATT-0001-0001-0001-0001",
"href": "v1/catalog/enrollment/attachment/ATT-0001-0001-0001-0001",
"name": "Guide to establishing a reseller relationship",
"description": "Learn what happens when you establish a reseller relationship with SoftwareOne",
"type": "File",
"reference": "microsoft-agreement-certification.pdf",
"order": {
"id": "ORD-5542-1187-3130-0991",
"href": "/commerce/orders/ORD-5542-1187-3130-0991"
},
"audit": {
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
}
}{
"id": "ORD-5542-1187-3130-0991",
"href": "/commerce/orders/ORD-5542-1187-3130-0991"
}OK
GET /public/v1/program/enrollments/{enrollmentId}/attachments HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {},
"updated": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"type": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"enrollment": {
"id": "text",
"applicableTo": "text",
"type": "text",
"eligibility": {
"client": true,
"partner": true
},
"status": "text"
}
}
]
}Created
Bad Request
POST /public/v1/program/enrollments/{enrollmentId}/attachments HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 67
{
"attachment": {
"Name": "text",
"Description": "text"
},
"file": "binary"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"type": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"enrollment": {
"id": "text",
"applicableTo": "text",
"type": "text",
"eligibility": {
"client": true,
"partner": true
},
"status": "text"
}
}OK
Not Found
PUT /public/v1/program/enrollments/{enrollmentId}/attachments/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 377
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"type": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"enrollment": {
"id": "text",
"applicableTo": "text",
"type": "text",
"eligibility": {
"client": true,
"partner": true
},
"status": "text"
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"type": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"enrollment": {
"id": "text",
"applicableTo": "text",
"type": "text",
"eligibility": {
"client": true,
"partner": true
},
"status": "text"
}
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/enrollments/{enrollmentId}/attachments/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
Moved Permanently
No content
Not Found
GET /public/v1/program/enrollments/{enrollmentId}/attachments/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"type": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"enrollment": {
"id": "text",
"applicableTo": "text",
"type": "text",
"eligibility": {
"client": true,
"partner": true
},
"status": "text"
}
}