Skip to content

Return renewal workflow operations matching the supplied filters.

GET
/api/workspace/entitlement-operations/renewal-operations
curl --request GET \
--url 'https://example.com/api/workspace/entitlement-operations/renewal-operations?Status=0&OperationKind=0'
  • None
ModelId
string
PlanId
string
EntitlementId
string
Status
integer format: int32
Allowed values: 0 1 2 3 4
OperationKind
integer format: int32
Allowed values: 0 1
DueFromUtc
string format: date-time
DueToUtc
string format: date-time
Search
string
Page
integer format: int32
PageSize
integer format: int32
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data

Paginated renewal operation list response.

object
Items
Array<object>
nullable

Renewal operation summary row.

object
Id
string
nullable
EntitlementId
string
nullable
EntitlementNumber
integer format: int64
EntitlementPlanId
string
nullable
EntitlementPlanDisplayName
string
nullable
EntitlementModelId
string
nullable
EntitlementModelDisplayName
string
nullable
EntitlementPeriodId
string
nullable
RenewalPolicyId
string
nullable
RenewalPolicyKey
string
nullable
OperationKind
integer format: int32
Allowed values: 0 1
DueAtUtc
string format: date-time
Status
integer format: int32
Allowed values: 0 1 2 3 4
ExternalReference
string
nullable
FailureCode
string
nullable
FailureMessage
string
nullable
RowVersion
string format: uuid
TotalCount
integer format: int32
Page
integer format: int32
PageSize
integer format: int32
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Items": [
{
"OperationKind": 0,
"Status": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}