Get a list of available contract profiles

get/contract-profiles
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
id
string (IdFilterParam)

Filter by id

Example: id=0
contractOwnerId
string (IdFilterParam)

Filter by contract owner

Example: contractOwnerId=0
name
string (StringFilterParam)

Filter by contract profile name

Example: name=xyz | in:x,y | like:xyz
rolloverContractProfileId
string (IdFilterParam)

Filter by rollover contract profile

Example: rolloverContractProfileId=0
includeSupersededVersions
string (BooleanFilterParam)

Filter to include superseded i.e. old versions of the profile

Example: includeSupersededVersions=true | false
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Response samples
application/json
[
  • {
    • "id": 1,
    • "name": "string",
    • "contractOwnerId": 0,
    • "createdDate": "2019-08-24T14:15:22Z",
    • "contractTerm": 0,
    • "earlyTerminationFixedCharge": 0,
    • "earlyTerminationPercentageCharge": 1000,
    • "rolloverContractProfileId": 0,
    • "renewalAlertDays": 28,
    • "noticePeriodDays": 2147483647,
    • "supersededByContractProfileId": 0
    }
]