Update a catalog

Update an existing catalog

Request

PUT https://api.staging.nexway.build/catalogs/{id}

Path parameters

Parameter name Value Description Additional
id string

id

Required

Request body

The request body takes a complete AbstractCatalog resource, containing the following writable properties:

{
    "createDate": "date-time",
    "customerId": "string",
    "dbVersion": "int64",
    "endDate": "string",
    "id": "string",
    "name": "string",
    "running": "boolean",
    "singleUse": "boolean",
    "startDate": "string",
    "status": "string",
    "type": "string",
    "updateDate": "date-time"
}

Properties

Name Type Description Additional
createDate date-time Optional
customerId string Optional
dbVersion int64 Optional
endDate string Optional
id string Optional
name string Optional
running boolean Optional
singleUse boolean Optional
startDate string Optional
status string

Possible values are:

  • ENABLED
  • DISABLED
Optional
type string

Possible values are:

  • INTERNAL
  • FULL_REMOTE
  • PRICING_REMOTE
  • VARIANT_PRICING_REMOTE
  • SIGNED
Optional
updateDate date-time Optional

Authorisation

This request requires the use of one of following authorisation methods: OAuth2.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Success

AbstractCatalog
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Failure

Example

{
    "endDate": "yyyy-MM-dd'T'HH:mm:ss'Z'",
    "startDate": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}

Explore this API

id

id

catalog

catalog

Request Content-Type
Response Content-Type

Choose an authorisation method:

Access Token Access token to be used for request
Try it out!