Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The following diagram shows the state (status) transition process of a certificate. It shows the possible states a certificate can have and the transition between those states.
New
This is the initial status of a certificate, and it's assigned by the platform when the certificate is being created.
Pending
The certificate has been created successfully, and it's awaiting approval by the vendor.
Active
The certificate is active and can be used when placing an order.
Expired
The certificate has expired. Expired certificates can be renewed by re-enrolling in the program.
Updating
The certificate is being updated due to re-enrollment in the program.
Terminated
The certificate has been terminated. Terminated certificates can't be used to re-enroll in a program.
Get the terms for a program.
The Terms Variant Object represents a terms variant as an uploaded PDF or DOCX document, or a link to an externally hosted document, as an element of the terms for a program.
This object contains the following attributes:
id
string
Get an item of media for a program.
(Read-only) The business identifier of the terms variant.
href
string
(Read-only) The resource URI of the terms variant.
type
string, core
Terms Item type. The possible values are Online or File.
name
string, core
The name of the term's variant.
description
string, core
The description of the term's variant.
assetUrl
string, core
The URL of the terms item uploaded document or online document/resource.
languageCode
string, core
A 2-digit language code from the list of language codes in ISO 639 and its corresponding data format. When the type is Online, null will appear as multiple on the UI.
status
string, core
The status of the terms variant. Allowed values are:
Draft
Published
Unpublished
Published
program
object
Represents the program to which the term item belongs.
audit
object
(Read-only) Represents the audit object.
{
"id": "TCS-1234-1234-1234-1234",
"href": "/programs/PRG-1234-1234/terms/TCS-1234-1234-1234/variants/TCV-1234-1234-1234-1234",
"name": "Terms and Conditions Variant - EN",
"description": "Terms and Conditions Variant in English",
"type": "Online",
"assetUrl": "https://www.microsoft.com",
"languageCode": "en",
"state": "Draft",
"termsAndConditions": {
"id": "TCS-1234-1234-1234",
"href": "/programs/PRG-1234-1234/terms/TCS-1234-1234-1234",
"name": "Microsoft 365 Terms of Service"
},
"audit": {
"created": {
"at": "2024-01-16T21:30:13.1046031",
"by": {
"id": "USR-0000-0001"
}
},
"updated": null
}
}Update an item of media for a program.
Unpublish an item of media for a program
Publish an item of media for a program.
The following diagram shows the state (status) transition process of a program in the platform. It shows the possible states a program can have and the transition between those states.
New
This is the initial status, and it's assigned by the platform when the program is created.
Create the terms for a program.
Draft
The program creation has begun, but it hasn’t been published.
Published
The program has been published and it's available in the Marketplace.
Unpublished
The program has been unpublished, and it's no longer available for new enrollments in the Marketplace.
Deleted
The program has been deleted.
The Program Parameters object is a mechanism that enables vendors to specify additional information to be collected from and shared with a client, so that the client can get self-served within the SoftwareOne Marketplace.
This object contains the following attributes:
id
Update the terms for a program.
string
(Read-only) The business identifier of the Parameter object.
href
string
(Read-only) A reference to the resource.
scope
string
(Read-only) The scope in which the parameter will be used. Allowed values: agreement, item, request, or subscription.
phase
string
(Read-only) The phase in which the process will be used. Allowed values: configuration, order, or fullfilment.
type
string
(Read-only) Indicates the UI component that will be used to capture information. Allowed values:
SingleLineText
MultiLineText
Address
Contact
Checkbox
Choice
Subdomain
Heading
DropDown
Email
DataObject
Date
options
object
These are specific to a selected type and allow customization of the UI component.
Example:
constraints
object
Represents the constraints object, which specifies characteristics of the entire parameter, impacting value validation. For example, enabling 'Optional' overrides mandatory fields in UI components associated with the selected type.
group
object
(Optional) Represents the parameterGroup object, allowing logical grouping of parameters. It is used by the purchase wizard and represented as a step within the wizard.
externalId
string
(Optional) Used for programmatic processing, for example, as a variable name within templates or a connector process.
status
string
The status of the parameter. Only active parameters are returned.
{
"label": "Client address",
"hintText": "enter your email",
"placeholderText": "someone@org.com",
"defaultValue": "none"
}{
"scope": "Agreement",
"phase": "Order",
"description": "Agreement identifier of the reseller",
"externalId": "RES-233-33-xx3",
"displayOrder": 100,
"constraints": {
"hidden": true,
"readonly": true,
"required": false
},
"type": "SingleLineText",
"options": {
"name": "Agreement Id",
"placeholderText": "AGR-xxx-xxx-xxx",
"hintText": "Add agreement id",
"minChar": 15,
"maxChar": 15,
"defaultValue": null
},
"group": {
"id": "PGR-7373-6782"
},
"status": "active"
}Publish the terms for a program.
The Program Template Object provides functionality for templates to be made and automatically delivered once a set of rules based on type is met. This enables the client to know what is happening with their order and if anything is needed of them.
This object contains the following attributes:
id
string
The business identifier of the program template.
href
string
The resource URI of the terms variant.
type
string
Indicates the type. Allowed values are:
certificateActivate
certificatePending
certificateExpired
enrollmentProcessing
enrollmentQuerying
enrollmentCompleted
name
string
The name of the template.
content
string
The content of the template.
default
boolean
Each program has 3 defaults automatically generated when the program is created.
Each automatically created template will include a default system message that the client account must update.
Defaults cannot be deleted, while non-defaults can be deleted.
program
Represents the program to which the term item belongs.
audit
(Read-only) Represents the audit object.
The Parameter Group Object represents a group of parameters. This object contains the following attributes:
id
string, core
(Read-only) The platform generated ID.
The Program object represents a set of requirements (parameters) that vendors ask their clients to meet.
This object contains the following attributes:
href
string, core
(Read-only) Relative reference to the object in the API.
name
string, core
The name of the group.
label
string
Label displayed in the wizard steps selector.
description
string
Description of the group.
displayOrder
integer
Defines the display order.
default
boolean
Marks the default item group.
parameterCount
integer
(Read-only)The number of parameters in the group.
program
object
A reference to the program object.
{
"id": "PGR-6790-8304-0001",
"href": "/program/PRG-6790-8304/parameter-groups/PGR-6790-8304-0001",
"title": "Parameters",
"label": "Create agreement",
"description": "When creating a new agreement with SoftwareOne, you have the option to establish a new Microsoft account or connect it to an existing account you already hold with Microsoft.",
"displayOrder": 100,
"default": true,
"program": {
"id": "PRG-6790-8304-0171"
}
}name
string, core
The program name.
website
string
The URL of the program website.
icon
string, core
The program logo or icon.
shortDescription
string
(Optional) A short description of program, shown in the card.
longDescription
string
(Optional) A long description of program, shown on details page.
status
string, core
The status of the program. Allowed values are:
None
Draft
Published
eligibility
string, core
Represents an object for storing information for the clients and reseller flags.
applicableTo
string, core
Allowed values are buyer or licensee.
products
object, core
Represents the object, containing a list of selected products.
Example:
vendor
object
Represents the vendor object. Example:
settings
object
Represents the object.
Example:
statistics
object
(Read-only) Represents the object. Example:
audit
object
(Read-only) Represents the object.
This object contains the following attributes:
newCertificateAutoapprove
boolean
Automatically activates every new certificate request for this program.
programEnrolment
boolean
This object contains the following attributes:
certificates
integer
(Read-only) Total number of verified certificates.
id
string, core
(Read-only) The program's identifier.
{
"id": "PRG-1234-5678",
"name": "Microsoft AI Cloud Partner",
"website": "https://www.microsoft.com",
"icon": "/v1/program/programs/PRG-1234-1234/icon",
"status": "Draft",
"eligibility": {
"client": true,
"partner": true
},
"applicableTo": "Buyer",
"products": [
{
"id": "PRD-1111-1111",
"name": "Microsoft Office 365 NCE",
"externalIds": {},
"icon": "/static/PRD-1111-1111-1111/logo.png",
"status": "Published"
}
],
"vendor": {
"id": "ACC-1234-1234",
"type": "Vendor",
"status": "Enabled",
"name": "Microsoft"
},
"settings": {
"newCertificateAutoapprove": true,
"programEnrollment": false,
"programLink": false,
"terminateOnExpiration": {
"enabled": true,
"duration": 30
},
"preValidation": {
"enrollmentDraft": false,
"enrollmentQuerying": false,
"reEnrollment": false
}
},
"statistics": {
"certificates": 100,
}
}Unpublished
Deleted
Displays the Enrol button on the program profile, enabling the client to place a request for this program.
programLink
boolean
Displays the Info button on the program profile, enabling clients to go to a URL to get more information.
terminateOnExpiration
boolean
Terminates the certificate on the expiration date, if the certificates have an expiration date.
terminateOnExpiration.enabled
boolean
Sets whether the certificates expire.
terminateOnExpiration.duration
number
The duration in days.
preValidation
boolean
Contains settings for the prevalidation phase during enrollment.
preValidation.enrollmentDraft
boolean
Validates change enrollment during the creation and before the enrollment is submitted.
preValidation.enrollmentQuerying
boolean
Validates querying enrollment during the creation and before the enrollment is submitted.
preValidation.reEnrollment
boolean
Validates before and during the re-enrollment.
[
{
"id": "PRD-1111-1111",
"name": "Microsoft Office 365 NCE",
"externalIds": {},
"icon": "/static/PRD-1111-1111-1111/logo.png",
"status": "Published"
}
]{
"id": "ACC-1234-1234",
"type": "Vendor",
"status": "Enabled",
"name": "Microsoft"
} "settings": {
"newCertificateAutoapprove": true,
"programEnrollment": false,
"programLink": false,
"terminateOnExpiration": {
"enabled": true,
"duration": 30
},
"preValidation": {
"enrollmentDraft": false,
"enrollmentQuerying": false,
"reEnrollment": false
}
} {
"certificates": 110
}Manage programs, certificates, and enrollments with the Program API.
The Program API provides secure endpoints for creating, retrieving, updating, and managing programs, certificates, and enrollments within the Marketplace Platform.
With this API, you can also perform additional operations, including:
Publish and unpublish programs.
Update program settings.
Manage program groups and parameters.
Create and manage program documents, media, and terms & conditions.
Create and manage program templates.
Submit and retrieve enrollment requests.
Validate enrollments in the draft and querying states.
Manage attachments associated with enrollments.
Process or fail enrollment requests.
Retrieve an enrollment's template.
Review the shared API docs before you work with program resources.
The Program API is built around the following core resources:
Certificate – Issued to a client or partner as confirmation that they meet a specific program's requirements.
Enrollment – Process through which a client formally registers or signs up to participate in a vendor program.
Program – Represents a set of requirements (parameters) that vendors ask their clients to meet.
The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.
Use the following links to jump to the collection you need:
POST
Migrates a certificate.
ops
GET
Returns a list of all certificates.
vendor, client, ops
GET
Returns a certificate with the given id.
vendor, client, ops
PUT
Updates an existing certificate.
vendor, client, ops
POST
Terminates an active certificate.
vendor
Expire certificate
POST
Expires an active certificate.
vendor
Get certificate template
GET
Gets a template for a certificate.
vendor, client, ops
POST
Creates a new enrollment and certificate.
client
POST
Validates draft enrollment data.
client
POST
Validates enrollment state.
vendor, client
POST
Changes enrollment status to processing.
vendor, client
POST
Changes enrollment status to querying.
vendor
POST
Changes enrollment status to complete.
vendor
POST
Changes enrollment status to failed.
vendor
Assign enrollment
POST
Assigns a user to an enrollment.
vendor
GET
Lists enrollments visible to the user.
vendor, client, ops
GET
Gets an enrollment by id.
vendor, client, ops
Update enrollment
PUT
Updates some properties of an enrollment.
vendor, client, ops
Delete enrollment
DELETE
Deletes an enrollment.
client
GET
Renders the template for the given enrollment id.
vendor, client, ops
GET
Gets a list of enrollment attachments.
ops, client
GET
Gets an enrollment attachment by id.
ops, client
POST
Creates a new enrollment attachment.
ops, client
PUT
Updates an existing enrollment attachment.
ops, client
DELETE
Deletes an existing enrollment attachment.
ops, client
POST
Creates a new program.
vendor
GET
Fetches a list of programs.
vendor, client, ops
GET
Gets a program by id.
vendor, client, ops
PUT
Updates some properties of a program.
vendor
DELETE
Deletes a program.
vendor
POST
Publishes a program.
vendor
POST
Unpublishes a program.
vendor
PUT
Updates a program’s settings.
vendor
POST
Creates a program parameter.
vendor
GET
Gets a list of parameters for a program.
vendor, client, ops
GET
Gets a program parameter definition.
vendor, client, ops
PUT
Updates a program parameter definition.
vendor
DELETE
Deletes a program parameter definition.
vendor
POST
Creates a new parameter group for a program.
vendor
GET
Lists all parameter groups for a program based on filter criteria.
vendor, client, ops
GET
Gets a parameter group by id for a program.
vendor, client, ops
PUT
Updates a parameter group for a program.
vendor
DELETE
Deletes a parameter group from a program.
vendor
POST
Creates a new document.
vendor
GET
Lists all documents based on filter criteria.
vendor, client, ops
GET
Gets a document by id.
vendor, client, ops
PUT
Updates a document.
vendor
DELETE
Removes a document.
vendor
POST
Publishes a document.
vendor
POST
Unpublishes a document.
vendor
POST
Creates new media for a program.
vendor
GET
Gets a list of media for a program.
vendor, client, ops
GET
Gets an item of media for a program.
vendor, client, ops
PUT
Updates an item of media for a program.
vendor
POST
Publishes an item of media for a program.
vendor
POST
Unpublishes an item of media for a program.
vendor
DELETE
Deletes an item of media for a program.
vendor
POST
Creates terms for a program.
vendor
GET
Gets a list of all terms for a program.
vendor, client, ops
GET
Gets terms for a program by id.
vendor, client, ops
PUT
Updates terms for a program.
vendor
DELETE
Deletes terms for a program.
vendor
POST
Publishes terms for a program.
vendor
POST
Unpublishes terms for a program.
vendor
POST
Creates a variant for terms.
vendor
GET
Gets a list of all variants for terms.
vendor, client, ops
GET
Gets a variant for terms by id.
vendor, client, ops
PUT
Updates a variant for terms for a program.
vendor
DELETE
Deletes a variant for terms.
vendor
POST
Publishes a variant for terms.
vendor
POST
Unpublishes a variant for terms.
vendor
POST
Creates a template for a program.
vendor
GET
Gets a list of templates for a program.
vendor, client, ops
GET
Gets a template for a program.
vendor, client, ops
PUT
Updates a template for a program.
vendor
DELETE
Deletes a template for a program.
vendor
Get a list of all terms for a program.
Create a new document.
In the Marketplace Platform, an enrollment progresses through several states (also known as statuses) during its lifecycle. The following diagram shows the possible states and the transitions between these states:
New
This is the initial status for a newly created enrollment in the platform.
Processing
The enrollment has been submitted, and it's undergoing approval processing.
Querying
The vendor requires more information to process your enrollment.
Complete
The vendor has approved your enrollment and activated your certificate.
Failed
The vendor has rejected your enrollment request.
Get a document by ID.
The Program Media object allows vendors to add, view, or delete media from the object.
This object contains the following attributes:
id
string
(Read-only) The business identifier of the media object.
name
string
(Read-only) The name of the media object.
description
string
A description of the media object.
type
string
The type of the media object.
displayOrder
integer
The display order of the media object.
status
string
The status of the document object. Allowed values are:
Draft
Published
Unpublished
Deleted
program
object
Represents the program to which the media belongs.
audit
object
Represents the audit object.
{
"id": "MED-1234-1234",
"href": "v1/catalog/programs/media/MED-1234-1234",
"name": "Microsoft AI Cloud Partner",
"description": "Build a solid foundation with the support of workplace specialists who take the time to understand your unique business needs.",
"type": "Image",
"url": "https://address.to.media.file.pl/abcde.png",
"displayOrder": 100,
"state": "Draft",
"program": {
"id": "PRG-1111-1111",
"href": "/catalog/programs/PRG-1111-1111",
"name": "Microsoft Office 365 NCE",
"icon": "/static/PRG-1111-1111/logo.png"
},
"audit": {
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
}
}The Program Document object allows you to upload program documentation using an online link or file upload to the Program object.
This object contains the following attributes:
id
string
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
(Read-only) The business identifier of the document object.
name
string
The name of the document object.
description
string
The description of the document object.
type
string
The type of the document object.
url
string
The URI to access the document object.
language
string
The document's language.
status
string
Represents the status of the document object.
program
object
Represents the to which the document belongs.
audit
object
Represents the object.
{
"id": "PDM-1234-5678-0001",
"name": "Guide to establishing a reseller relationship",
"description": "Learn what happens when you establish a reseller relationship with SoftwareOne",
"type": "File",
"url": "https://address.to.media.file.pl/abcde.docx",
"language": "pl-pl",
"state": "Draft",
"program": {
"id": "PRG-1234-5678",
"name": "Microsoft AI Cloud Partner",
"icon": "/static/PRG-1234-1234/logo.png"
},
"audit": {
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
}
}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"
}Create new media for a program.
Publish a document.
Lists all documents based on filter criteria.
Delete the terms for a program.
Delete an item of media for a program.
Unpublish the terms for a program.
Enrollment is a process through which a client formally registers or signs up to participate in a vendor program.
Once the client fulfills all the necessary conditions, they are considered enrolled in the program, and a certificate is issued.
This object contains the following attributes:
This object contains the following attributes:
This object contains the following attributes:
externalId
string
The ID of the parameter in the external system.
value
string
The parameter value, which can be updated.
displayValue
string
The parameter value (read only).
constraints
object
Represents constraints.
When specified, it represents overridden parameter constraints.
When unspecified, the parameter constraints must be taken from the parameter definition.
error
object
Represents the error object.
id
string, core
(Read-only) The identifier for the enrollment.
href
string, core
(Read-only) Represents the enrollment in the API.
certificate
object, core
Represents the certificate object for this enrollment.
Example:
{
"id": "PRG-1234-5678",
"href": "/program/programs/PRG-1234-5678",
"name": "Microsoft AI Cloud Partner"
}program
object, core
Represents the program object that the partner enrolls in.
Example:
{
"id": "PRG-1234-1234",
"href": "v1/catalog/programs/PRG-1234-5678",
"name": "Microsoft AI Cloud Partner",
"icon": "/static/PRG-1234-1234/logo.png",
"applicableTo": "Buyer"
}applicableTo
string, core
Defines the scope of the enrollment. Allowed values are buyer or licensee.
type
string, core
Defines whether the enrollment is new (first time requesting a certificate) or a change (re-enrollment). Allowed values are change or new.
buyer
object, core
(Optional) Represents the buyer object, if the enrollment applies to a buyer.
Example:
{
"id": "PRG-1234-1234",
"href": "v1/catalog/programs/PRG-1234-5678",
"name": "Microsoft AI Cloud Partner",
"icon": "/static/PRG-1234-1234/logo.png",
"applicableTo": "Buyer"
}licensee
object, core
(Optional) Represents the licensee object, if the enrollment applies to a licensee.
Example:
{
"id": "CER-1234-1234",
"href": "v1/accounts/licensees/LIC-1234-1234-1234"
"name": "Stark Industries Limited",
"externalId": "WW-CON-12345678"
}eligibility
object, core
The eligibility object containing the configuration of the partner program.
Example:
{
"client": true,
"partner": false
}status
enum
The enrollment status. Allowed values are:
Processing
Failed
Completed
Querying
statusNotes
object
(Optional) Notes added during a status change by the vendor or extensions, indicating the reason for enrollment failure or status change.
Example:
{
"id": "E001234",
"message": "Educational certification failed"
}notes
string
(Optional) Contains initial customer notes added by the Buyer during the enrollment process. Buyers can edit and add notes at any time for all order statuses.
error
object
(Optional) The standard error object, indicating that an error occurred during parameter validation. May include markup.
Example:
{
"id": "E001234",
"message": "Enrollment has invalid parameters"
}assignee
object
(Optional) The enrollment assignee, set by the vendor. The account must belong to the vendor account.
Example:
{
"id": "USR-3773-5838",
"href": "/accounts/ACC-0774-6909/users/USR-3773-5838",
"name": "Jack Doe",
}parameters.fulfillment
object
(Optional) Represents the enrollmentParameter object, which holds a concise definition of a parameter, its value, and any associated errors.
Example:
[
{
"id": "PRM-1234-1234-1234",
"name": "Tennant Id",
"externalId": "tenant_id",
"constraints": {
"readonly": false,
"hidden": true,
"required": true,
"unique": false
},
"value": "69b73824-ce76-4866-ad47-b615ae9d8998",
"error": {
"id": "E001234",
"message": "Incorrect parameter value"
}
}
]parameters.ordering
object
(Optional) Represents the enrollmentParameter object, which holds a concise definition of a parameter, its value, and any associated errors.
Example:
[
{
"id": "PRM-1234-1234-1234",
"name": "Microsoft Partner Number",
"externalId": "partner_id",
"constraints": {
"readonly": false,
"hidden": true,
"required": true,
"unique": false
},
"value": "69b73824-ce76-4866-ad47-b615ae9d8998",
"error": {
"id": "E001234",
"message": "Incorrect parameter value"
}
}
]template
object
(Optional) Represents the template object.
Example:
{
"id": "PTP-1234-4444",
"href": "/programs/PRG-1234-1234/templates/TPP-1234-4444",
"name": "Successful Activation" }audit
object
(Read-only) Represents the audit object.
client
boolean
Indicates direct client.
partner
boolean
id
string
The primary identifier for the parameter.
name
string
{
"id": "ENR-1234-1234",
"href": "/v1/products/PRD-1234-1234",
"certificate": {
"id": "CER-1234-1234",
"href": "v1/catalog/certificates/CER-1234-1234"
},
"program": {
"id": "PRG-1234-1234",
"href": "v1/catalog/programs/PRG-1234-5678",
"name": "Microsoft AI Cloud Partner",
"icon": "/static/PRG-1234-1234/logo.png",
"applicableTo": "Buyer"
},
"applicableTo": "Buyer",
"buyer": {
"id": "BUY-1234-1234",
"href": "v1/accounts/buyers/BUY-1234-1234",
"name": "MPN EU"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "Processing",
"notes": "draft enrollment for review",
"assignee": "",
"parameters.fulfillment": [
{
"id": "PRM-1234-1234-1234",
"name": "Tennant Id",
"externalId": "tenant_id",
"constraints": {
"readonly": false,
"hidden": true,
"required": true,
"unique": false
},
"value": "69b73824-ce76-4866-ad47-b615ae9d8998",
"error": {
"id": "E001234",
"message": "Incorrect parameter value"
}
}],
"parameters.ordering": []
}
{
"id": "PAR-1234-1234-1234-1234",
"name": "Tennant Id",
"externalId": "tenant_id",
"constraints": {
"readonly": false,
"hidden": true,
"required": true
},
"value": "69b73824-ce76-4866-ad47-b615ae9d8998",
"error": {
"id": "E001234",
"message": "Incorrect parameter value"
}
}Indicates indirect client or partner.
The display name of the parameter.
{
"addressLine1": "23 Oakley wood",
"city": "Cork",
"state": "Cork",
"postalCode": "V23U58N"
}Update document.
OK
Not Found
GET /public/v1/program/programs/{programId}/terms/{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": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 120
{
"variant": {
"Type": "Online",
"AssetUrl": "text",
"LanguageCode": "text",
"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"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}OK
GET /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants 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"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}
]
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/parameter-groups/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
Moved Permanently
No content
Bad Request
Not Found
GET /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{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"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"name": "text",
"description": "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"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}OK
GET /public/v1/program/programs/{programId}/parameters 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",
"group": {
"id": "text",
"name": "text"
},
"scope": "Enrollment",
"phase": "Order",
"externalId": "text",
"displayOrder": 1,
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
},
"options": null,
"type": "SingleLineText",
"status": "text"
}
]
}OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/programs/{id}/settings HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 219
{
"newCertificateAutoapprove": true,
"programEnrollment": true,
"programLink": true,
"terminateOnExpiration": {
"enabled": true,
"duration": 1
},
"preValidation": {
"enrollmentDraft": true,
"enrollmentQuerying": true,
"reEnrollment": true
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"website": "text",
"icon": "text",
"status": "text",
"eligibility": {
"client": true,
"partner": true
},
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"pending": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
],
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"newCertificateAutoapprove": true,
"programEnrollment": true,
"programLink": true,
"terminateOnExpiration": {
"enabled": true,
"duration": 1
},
"preValidation": {
"enrollmentDraft": true,
"enrollmentQuerying": true,
"reEnrollment": true
}
},
"statistics": {
"certificates": 1
}
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id}/publish 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"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms/{programTermsAndConditionsId}/variants/{id}/unpublish 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"
]
},
"type": "text",
"assetUrl": "text",
"languageCode": "text",
"name": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"programTermsAndConditions": {
"id": "text",
"name": "text"
},
"fileId": "text"
}OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/programs/{programId}/parameter-groups/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 1190
{
"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",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"parameterCount": 1,
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}{
"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",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"parameterCount": 1,
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}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"
}
}Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/parameter-groups HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"name": "text",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true
}{
"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",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"parameterCount": 1,
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
GET /public/v1/program/programs/{programId}/templates 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",
"content": "text",
"default": true,
"type": "text",
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
}
}
]
}OK
Not Found
GET /public/v1/program/programs/{programId}/parameters/{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",
"group": {
"id": "text",
"name": "text"
},
"scope": "Enrollment",
"phase": "Order",
"externalId": "text",
"displayOrder": 1,
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"options": null,
"type": "SingleLineText",
"status": "text"
}OK
Moved Permanently
No content
Not Found
GET /public/v1/program/programs/{programId}/media/{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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"displayOrder": 1,
"url": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/certificates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 200
{
"parameters": {
"ordering": [
{
"id": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"value": null
}
]
},
"template": {
"id": "text"
},
"expirationDate": "2026-01-01",
"externalIds": {
"vendor": "text"
},
"name": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"pending": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"terminated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"expired": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"name": "text",
"externalIds": {
"vendor": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"applicableTo": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"expirationDate": "2026-01-01",
"template": {
"id": "text",
"name": "text",
"type": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"accepted": "2026-01-01T00:00:00.000Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
]
}OK
Bad Request
Not Found
Internal Server Error
No content
GET /public/v1/program/enrollments/{id}/render HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
textOK
Not Found
PUT /public/v1/program/programs/{programId}/media/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 1232
{
"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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"displayOrder": 1,
"url": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}{
"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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"displayOrder": 1,
"url": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/templates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/media/{id}/unpublish 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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"displayOrder": 1,
"url": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{id}/publish 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": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"website": "text",
"icon": "text",
"status": "text",
"eligibility": {
"client": true,
"partner": true
},
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"pending": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
],
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"newCertificateAutoapprove": true,
"programEnrollment": true,
"programLink": true,
"terminateOnExpiration": {
"enabled": true,
"duration": 1
},
"preValidation": {
"enrollmentDraft": true,
"enrollmentQuerying": true,
"reEnrollment": true
}
},
"statistics": {
"certificates": 1
}
}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"
}
}
]
}OK
Bad Request
Not Found
PUT /public/v1/program/programs/{programId}/parameters/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 209
{
"name": "text",
"description": "text",
"externalId": "text",
"displayOrder": 1,
"constraints": {
"Required": true,
"Hidden": true,
"ReadOnly": true
},
"options": {
"hintText": "text",
"defaultValue": "text"
},
"group": {
"id": "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",
"group": {
"id": "text",
"name": "text"
},
"scope": "Enrollment",
"phase": "Order",
"externalId": "text",
"displayOrder": 1,
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"options": null,
"type": "SingleLineText",
"status": "text"
}OK
GET /public/v1/program/certificates 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": {},
"activated": {},
"pending": {},
"terminated": {},
"expired": {},
"updating": {}
},
"$meta": {
"omitted": [
"text"
]
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
},
"name": "text",
"externalIds": {
"vendor": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"applicableTo": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"expirationDate": "2026-01-01",
"template": {
"id": "text",
"name": "text",
"type": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {},
"accepted": "2026-01-01T00:00:00.000Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
]
}
]
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/parameters/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
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
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"
}
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/enrollments/{id}/complete HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"template": {
"id": "text"
},
"externalIds": {
"vendor": "text"
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"processing": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"querying": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"certificate": {
"id": "text",
"name": "text"
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "text",
"type": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text",
"type": "text"
}
}Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"name": "text",
"description": "text",
"displayOrder": 1
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{id}/unpublish 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": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"website": "text",
"icon": "text",
"status": "text",
"eligibility": {
"client": true,
"partner": true
},
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"pending": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
],
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"newCertificateAutoapprove": true,
"programEnrollment": true,
"programLink": true,
"terminateOnExpiration": {
"enabled": true,
"duration": 1
},
"preValidation": {
"enrollmentDraft": true,
"enrollmentQuerying": true,
"reEnrollment": true
}
},
"statistics": {
"certificates": 1
}
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/enrollments/{id}/fail HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"processing": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"querying": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"certificate": {
"id": "text",
"name": "text"
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "text",
"type": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text",
"type": "text"
}
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/templates HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"name": "text",
"type": "EnrollmentProcessing",
"default": true,
"content": "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",
"content": "text",
"default": true,
"type": "text",
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/programs/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 434
{
"program": {
"Program.Node.Name": "text",
"Program.Node.Children": [
{
"name": "text"
}
],
"Program.Path": "text",
"Program.Data.Name": "text",
"Program.Data.ShortDescription": "text",
"Program.Data.LongDescription": "text",
"Program.Data.Website": "text",
"Program.Data.Eligibility.Client": true,
"Program.Data.Eligibility.Partner": true,
"Program.Data.ApplicableTo": "Buyer",
"Program.Data.Products": [
{
"id": "text"
}
],
"Program.IsDefined": true
},
"icon": "binary"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"website": "text",
"icon": "text",
"status": "text",
"eligibility": {
"client": true,
"partner": true
},
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"pending": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
],
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"newCertificateAutoapprove": true,
"programEnrollment": true,
"programLink": true,
"terminateOnExpiration": {
"enabled": true,
"duration": 1
},
"preValidation": {
"enrollmentDraft": true,
"enrollmentQuerying": true,
"reEnrollment": true
}
},
"statistics": {
"certificates": 1
}
}Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/programs HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 187
{
"Program": {
"Name": "text",
"ShortDescription": "text",
"LongDescription": "text",
"Website": "text",
"ApplicableTo": "Buyer",
"Eligibility.Client": true,
"Eligibility.Partner": true
},
"icon": "binary"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"website": "text",
"icon": "text",
"status": "text",
"eligibility": {
"client": true,
"partner": true
},
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"pending": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
],
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"newCertificateAutoapprove": true,
"programEnrollment": true,
"programLink": true,
"terminateOnExpiration": {
"enabled": true,
"duration": 1
},
"preValidation": {
"enrollmentDraft": true,
"enrollmentQuerying": true,
"reEnrollment": true
}
},
"statistics": {
"certificates": 1
}
}OK
Not Found
GET /public/v1/program/programs/{programId}/parameter-groups/{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",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"parameterCount": 1,
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/programs/{programId}/terms/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"name": "text",
"description": "text",
"displayOrder": 1
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/certificates/{id}/terminate HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"pending": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"terminated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"expired": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"name": "text",
"externalIds": {
"vendor": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"applicableTo": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"expirationDate": "2026-01-01",
"template": {
"id": "text",
"name": "text",
"type": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"accepted": "2026-01-01T00:00:00.000Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
]
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/enrollments/{id}/process HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"template": {
"id": "text"
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"processing": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"querying": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"certificate": {
"id": "text",
"name": "text"
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "text",
"type": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text",
"type": "text"
}
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms/{id}/publish 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": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/certificates HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 207
{
"program": {
"id": "text"
},
"buyer": {
"id": "text"
},
"licensee": {
"id": "text"
},
"client": {
"id": "text"
},
"name": "text",
"parameters": {
"ordering": [
{
"id": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"value": null
}
]
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"pending": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"terminated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"expired": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"name": "text",
"externalIds": {
"vendor": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"applicableTo": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"expirationDate": "2026-01-01",
"template": {
"id": "text",
"name": "text",
"type": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"accepted": "2026-01-01T00:00:00.000Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
]
}OK
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/enrollments/{id}/validate HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 586
{
"program": {
"id": "text"
},
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"notes": "text",
"assignee": {
"id": "text"
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"parameters": {
"ordering": [
{
"id": "text",
"value": null,
"externalId": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
}
}
],
"fulfillment": [
{
"id": "text",
"value": null,
"externalId": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
}
}
]
},
"template": {
"id": "text"
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"processing": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"querying": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"certificate": {
"id": "text",
"name": "text"
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "text",
"type": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text",
"type": "text"
}
}OK
GET /public/v1/program/programs/{programId}/terms 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": {},
"published": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
}
}
]
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{id}/publish 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": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"website": "text",
"icon": "text",
"status": "text",
"eligibility": {
"client": true,
"partner": true
},
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"pending": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
],
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"newCertificateAutoapprove": true,
"programEnrollment": true,
"programLink": true,
"terminateOnExpiration": {
"enabled": true,
"duration": 1
},
"preValidation": {
"enrollmentDraft": true,
"enrollmentQuerying": true,
"reEnrollment": true
}
},
"statistics": {
"certificates": 1
}
}Created
Bad Request
POST /public/v1/program/programs/{programId}/documents HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 137
{
"document": {
"Name": "text",
"Description": "text",
"Language": "text",
"DocumentType": "Online",
"Url": "text",
"DisplayOrder": 1
},
"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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/enrollments/{id}/query HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"template": {
"id": "text"
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"processing": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"querying": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"certificate": {
"id": "text",
"name": "text"
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "text",
"type": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text",
"type": "text"
}
}OK
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/enrollments/validate HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 2311
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"processing": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"querying": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"certificate": {
"id": "text",
"name": "text"
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "text",
"type": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text",
"type": "text"
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"processing": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"querying": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"certificate": {
"id": "text",
"name": "text"
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "text",
"type": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text",
"type": "text"
}
}OK
GET /public/v1/program/programs 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": {},
"published": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"website": "text",
"icon": "text",
"status": "text",
"eligibility": {
"client": true,
"partner": true
},
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
],
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"newCertificateAutoapprove": true,
"programEnrollment": true,
"programLink": true,
"terminateOnExpiration": {
"enabled": true,
"duration": 1
},
"preValidation": {
"enrollmentDraft": true,
"enrollmentQuerying": true,
"reEnrollment": true
}
},
"statistics": {
"certificates": 1
}
}
]
}OK
Not Found
GET /public/v1/program/certificates/{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": {}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"pending": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"terminated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"expired": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"name": "text",
"externalIds": {
"vendor": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"applicableTo": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"expirationDate": "2026-01-01",
"template": {
"id": "text",
"name": "text",
"type": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"accepted": "2026-01-01T00:00:00.000Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
]
}OK
Moved Permanently
No content
Bad Request
Not Found
GET /public/v1/program/programs/{programId}/documents/{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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/programs/{programId}/templates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"name": "text",
"default": true,
"content": "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",
"content": "text",
"default": true,
"type": "text",
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}Created
Bad Request
POST /public/v1/program/programs/{programId}/media HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 112
{
"media": {
"Name": "text",
"Description": "text",
"MediaType": "Video",
"Url": "text",
"DisplayOrder": 1
},
"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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"displayOrder": 1,
"url": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Not Found
GET /public/v1/program/enrollments/{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": {}
},
"processing": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"querying": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"certificate": {
"id": "text",
"name": "text"
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "text",
"type": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text",
"type": "text"
}
}OK
Bad Request
Forbidden
Not Found
POST /public/v1/program/programs/{programId}/documents/{id}/publish 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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
GET /public/v1/program/programs/{programId}/documents 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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
}
}
]
}OK
Not Found
GET /public/v1/program/programs/{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": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"website": "text",
"icon": "text",
"status": "text",
"eligibility": {
"client": true,
"partner": true
},
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"pending": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
],
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"newCertificateAutoapprove": true,
"programEnrollment": true,
"programLink": true,
"terminateOnExpiration": {
"enabled": true,
"duration": 1
},
"preValidation": {
"enrollmentDraft": true,
"enrollmentQuerying": true,
"reEnrollment": true
}
},
"statistics": {
"certificates": 1
}
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/terms/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/media/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms/{id}/unpublish 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": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}OK
Not Found
GET /public/v1/program/programs/{programId}/templates/{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",
"content": "text",
"default": true,
"type": "text",
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
PUT /public/v1/program/programs/{programId}/documents/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 1220
{
"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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}No content
Remove a document.
Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/enrollments HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 235
{
"certificate": {
"id": "text"
},
"program": {
"id": "text"
},
"buyer": {
"id": "text"
},
"licensee": {
"id": "text"
},
"client": {
"id": "text"
},
"name": "text",
"parameters": {
"ordering": [
{
"id": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"value": null
}
]
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"processing": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"querying": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"failed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"certificate": {
"id": "text",
"name": "text"
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "text",
"type": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text",
"type": "text"
}
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/documents/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
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
Unpublish a document.
OK
GET /public/v1/program/programs/{programId}/parameter-groups 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",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"parameterCount": 1,
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
}
}
]
}OK
Bad Request
Forbidden
Not Found
POST /public/v1/program/programs/{programId}/documents/{id}/unpublish 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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"url": "text",
"language": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
}
}Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/parameters HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 270
{
"scope": "Enrollment",
"phase": "Order",
"name": "text",
"description": "text",
"externalId": "text",
"displayOrder": 1,
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"type": "SingleLineText",
"options": {
"hintText": "text",
"defaultValue": "text"
},
"group": {
"id": "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",
"group": {
"id": "text",
"name": "text"
},
"scope": "Enrollment",
"phase": "Order",
"externalId": "text",
"displayOrder": 1,
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"options": null,
"type": "SingleLineText",
"status": "text"
}The Program Terms object represents terms in the form of uploaded PDF or DOCX documents, as well as links to documents hosted externally.
This object contains the following attributes:
id
string
(Read-only) The business identifier of the terms.
href
string
(Read-only) The resource URI of the terms.
name
string, core
The name of the terms.
description
string, core
A description of the terms.
displayOrder
integer, core
The display order of the terms.
status
string, core
The status of the terms. Allowed values are:
Draft
Published
Unpublished
Published
program
object
Represents the program to which the term item belongs.
audit
object
(Read-only) Represents the audit object.
{
"id": "TCS-3159-1891-0980-8679",
"href": "/programs/PRG-6822-9898-4256/terms/TCS-3159-1891-0980-8679",
"name": "Microsoft 365 Terms of Service",
"description": "Description of Microsoft 365 Terms of Service",
"displayOrder": 100,
"state": "Draft",
"program": {
"id": "PRG-6822-9898-4256",
"href": "/programs/PRG-6822-9898-4256",
"name": "Microsoft AI Cloud Partner"
},
"audit": {
"created": {
"at": "2024-01-16T21:30:13.1046031",
"by": {
"id": "USR-0000-0001"
}
},
"updated": null
}
}OK
GET /public/v1/program/enrollments 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": {},
"processing": {},
"querying": {},
"completed": {},
"failed": {}
},
"$meta": {
"omitted": [
"text"
]
},
"certificate": {
"id": "text",
"name": "text"
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
},
"applicableTo": "text",
"type": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text",
"type": "text"
}
}
]
}A certificate is issued to a client or partner as confirmation that they meet a specific program's requirements. This document is proof that the client or partner has adhered to the vendor's standards and is now eligible to purchase or access their products.
The following rules apply to certificates:
A certificate can only be created or re-enrolled for published programs.
A client or partner can re-enroll for a certificate if it's in Active or Expired status. Re-enrollment is not permitted for terminated certificates.
A certificate can automatically expire on its expiration date, changing its status to Expired.
This object contains the following attributes:
This object contains the following attributes:
id
string, core
(Read-only) The business identifier of the certificate.
href
id
string
The identifier of the parameter definition this value refers to.
externalId
string
{
"id": "CER-1495-4162-8138",
"name": "Certainly a certificate",
"revision": 1,
"program": {
"id": "PRG-8803-8286",
"name": "Microsoft2 AI Cloud Friend",
"revision": 2,
"icon": "/v1/program/programs/PRG-8803-8286/icon",
"status": "Unpublished",
"applicableTo": "Licensee",
"products": [
{
"id": "PRD-0262-5461",
"name": "Don't touch it - testing in progress",
"icon": "/v1/catalog/products/PRD-0262-5461/icon",
"revision": 2,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-0506-8226",
"name": "iProduct",
"icon": "/v1/catalog/products/PRD-0506-8226/icon",
"revision": 2,
"externalIds": {
"operations": "12345"
},
"status": "Published"
},
{
"id": "PRD-1126-6342",
"name": "ProFour",
"icon": "/v1/catalog/products/PRD-1126-6342/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-1186-8657",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-1186-8657/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-1324-5809",
"name": "Test",
"icon": "/v1/catalog/products/PRD-1324-5809/icon",
"revision": 1,
"externalIds": {
"operations": "1666"
},
"status": "Pending"
},
{
"id": "PRD-1361-4823",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-1361-4823/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-1458-4448",
"name": "ProOne",
"icon": "/v1/catalog/products/PRD-1458-4448/icon",
"revision": 1,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-1503-5649",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-1503-5649/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-1695-6569",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-1695-6569/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-1712-6041",
"name": "This is another product",
"icon": "/v1/catalog/products/PRD-1712-6041/icon",
"revision": 31,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-2370-3582",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-2370-3582/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-2599-3780",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-2599-3780/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-2876-3270",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-2876-3270/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-3035-5906",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-3035-5906/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-3225-9621",
"name": "Adobius Agobius",
"icon": "/v1/catalog/products/PRD-3225-9621/icon",
"revision": 4,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-4087-9832",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-4087-9832/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-4113-0835",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-4113-0835/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-4358-5858",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-4358-5858/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-4438-6974",
"name": "Producto estupendo",
"icon": "/v1/catalog/products/PRD-4438-6974/icon",
"revision": 1,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-4584-0141",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-4584-0141/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-5008-6643",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-5008-6643/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-5423-8617",
"name": "Release 009",
"icon": "/v1/catalog/products/PRD-5423-8617/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-5469-4797",
"name": "Price List Items Test product",
"icon": "/v1/catalog/products/PRD-5469-4797/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-5486-6163",
"name": "Adobe Bo",
"icon": "/v1/catalog/products/PRD-5486-6163/icon",
"revision": 43,
"externalIds": {
"operations": "03543356356356365",
"defaultErpItem": "879878"
},
"status": "Published"
},
{
"id": "PRD-5624-3062",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-5624-3062/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-5636-4901",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-5636-4901/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-6435-6769",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-6435-6769/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-6478-2097",
"name": "AutomatedTajfunPending",
"icon": "/v1/catalog/products/PRD-6478-2097/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-6847-2813",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-6847-2813/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-6998-2587",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-6998-2587/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-7070-4351",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-7070-4351/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-7162-5819",
"name": "ProTwo",
"icon": "/v1/catalog/products/PRD-7162-5819/icon",
"revision": 3,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-7399-8133",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-7399-8133/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-7492-6453",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-7492-6453/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-7622-1820",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-7622-1820/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-7811-7846",
"name": "Tajfun",
"icon": "/v1/catalog/products/PRD-7811-7846/icon",
"revision": 3,
"externalIds": {
"operations": "1234567890"
},
"status": "Published"
},
{
"id": "PRD-8265-6648",
"name": "BluewindPro",
"icon": "/v1/catalog/products/PRD-8265-6648/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-8289-7768",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-8289-7768/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-8557-8571",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-8557-8571/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-8599-9806",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-8599-9806/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-8674-3473",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-8674-3473/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-8854-4878",
"name": "AutomatedTajfunUnpublished",
"icon": "/v1/catalog/products/PRD-8854-4878/icon",
"revision": 1,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-8854-7061",
"name": "AutomatedTajfunPublished",
"icon": "/v1/catalog/products/PRD-8854-7061/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-9298-0552",
"name": "ProThree",
"icon": "/v1/catalog/products/PRD-9298-0552/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-9689-6324",
"name": "Product with mad quantity of Terms",
"icon": "/v1/catalog/products/PRD-9689-6324/icon",
"revision": 1,
"externalIds": {
"operations": "IAMD3FAULT"
},
"status": "Unpublished"
},
{
"id": "PRD-9920-1302",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-9920-1302/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
}
]
},
"vendor": {
"id": "ACC-1762-8332",
"name": "Test Tajfun Vendor",
"icon": "/v1/accounts/accounts/ACC-1762-8332/icon",
"revision": 8,
"type": "Vendor",
"status": "Enabled"
},
"externalIds": {},
"client": {
"id": "ACC-7843-4996",
"name": "Experimental Client #37",
"revision": 1,
"type": "Client",
"status": "Active"
},
"applicableTo": "Licensee",
"licensee": {
"id": "LCE-2722-7432-2049",
"name": "US Licensee",
"revision": 1
},
"eligibility": {
"client": true,
"partner": true
},
"status": "Terminated",
"statusNotes": "this certificate needs to be terminated",
"expirationDate": "2025-01-31",
"parameters": {
"ordering": [],
"fulfillment": []
},
"audit": {
"terminated": {
"at": "2025-03-27T20:19:21.004Z",
"by": {
"id": "USR-0000-0032",
"name": "Mariya Surovtseva",
"revision": 1
}
},
"created": {
"at": "2025-02-03T10:52:56.814Z",
"by": {
"id": "USR-0000-0032",
"name": "Mariya Surovtseva",
"revision": 1
}
},
"updated": {
"at": "2025-04-25T16:45:51.902Z",
"by": {
"id": "USR-0000-0037",
"name": "Michael Saunders",
"revision": 1
}
}
}
}string, core
(Read-only) The resource URI of the certificate.
program
object, core
Represents the program to which this certificate applies.
Example:
client
object
Represents the client or partner account object to which the certificate belongs.
applicableTo
string, core
The scope in which the given enrollment is created. Allowed values are buyer or licensee.
buyer
object, core
(Optional) Represents the buyer object, if the enrollment applies to the buyer.
licensee
object, core
(Optional) Represents the licensee object if the enrollment applies to the licensee.
Example:
eligibility
eligibility, core
Configuration of the partner program.
Example:
externalIds
object
Represents the externalIds object, containing the identifier for the external system.
Example:
status
enum, core
(Read-only) The certificate's status. Allowed values are:
Pending
Updating
Active
Terminated
Expired
statusNotes
string
(Optional) Notes provided by the vendor to terminate a certificate.
expirationDate
dateTime
(Optional) The expiration date of the certificate. When the date has passed, the system expires the certificate.
template
object
(Optional) Represents the template object.
Example:
parameters.fulfillment
object
Represents the orderParameter object, which holds a definition of a parameter, its value, and associated errors.
Example:
parameters.ordering
object
Represents the orderParameter object, which contains a definition of a parameter, its value, and associated errors.
Example:
audit
object
(Read-only) Represents the audit object.
The ID of the parameter in the external system.
type
string
The type of the parameter definition.
name
string
The display name of the parameter.
value
string
The value of the parameter.
{
"id": "PRG-1234-5678",
"href": "/program/programs/PRG-1234-5678",
"name": "Microsoft AI Cloud Partner"
}{
"id": "CER-1234-1234",
"href": "v1/accounts/licensees/LIC-1234-1234-1234"
"name": "Stark Canada Limited",
"externalId": "WW-CON-12345678"
}{
"client": true,
"partner": false
}{
"vendor": "ven-1233-3222"
}{
"id": "PTP-1234-4444",
"href": "/programs/PRG-1234 1234/templates/TPP-1234-4444",
"name": "Successful Activation"
}[
{
"id": "PRM-1234-1234-1234",
"name": "Tenant Id",
"externalId": "tenant_id",
"constraints": {
"readonly": false,
"hidden": true,
"required": true,
"unique": false
},
"value": "69b73824-ce76-4866-ad47-b615ae9d8998",
"error": {
"id": "E001234",
"message": "Incorrect parameter value"
}
}
][
{
"id": "PRM-1234-1234-1234",
"name": "Tenant Id",
"externalId": "tenant_id",
"constraints": {
"readonly": false,
"hidden": true,
"required": true,
"unique": false
},
"value": "69b73824-ce76-4866-ad47-b615ae9d8998",
"error": {
"id": "E001234",
"message": "Incorrect parameter value"
}
}
]Get a list of media for a program.
OK
GET /public/v1/program/programs/{programId}/media 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",
"type": "text",
"description": "text",
"status": "text",
"filename": "text",
"size": 1,
"contentType": "text",
"displayOrder": 1,
"url": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
}
}
]
}