Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Update document.
Create a new document in catalog management.
The following diagram shows the possible states for the documentation object in the Marketplace Platform and the transition between these states:
State | Definition |
---|
Publish a document.
Draft | The documentation object is being created by the vendor. The object is not visible to the clients yet in the marketplace. |
Pending | The vendor has submitted the documentation object to SoftwareOne Operations for review and publishing. |
Published | The documentation object is visible in the marketplace. |
Unpublished | The documentation object is not visible in the marketplace. |
Deleted | The document object no longer exists. It's no longer part of the product definition and can't be used. |
Vendor removes a document.
Mark a document for review.
id
string
href
string
name
string
The name of the document object.
Example: "Guide to establishing a reseller relationship"
description
string
The description of the document object.
Example: "Learn what happens when you establish a reseller relationship with SoftwareOne"
type
string
The type of the document object/
url
string
The URI to access document object.
Example: " Polish"
language.name
string
Example: "pl-pl"
language.code
string
Example: "Guide to establishing a reseller relationship"
status
string
Draft, Published, or Deleted.
product
Example:
audit
Audit Object
Example:
Unpublish a document.
Lists all documents based on filter criteria.
Gets a document by id.
No Content
Success
Success
Success
Success
Success
No Content
Json representation of the document
Created