Get a list of customer contracts

get/customer-contracts
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
name
string (StringFilterParam)

Filter by customer contract name

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

Filter by customer

Example: customerId=0
siteId
string (IdFilterParam)

Filter by site

Example: siteId=0
contractProfileId
string (IdFilterParam)

Filter by contract profile

Example: contractProfileId=0
startDate
string (DateFilterParam)

Filter by start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDate
string (DateFilterParam)

Filter by end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
rolloverContractProfileId
string (IdFilterParam)

Filter by rollover contract profile

Example: rolloverContractProfileId=0
renewalAlert
string (BooleanFilterParam)

Filter by contracts within renewal alert day(s)

Example: renewalAlert=true | false
noticePeriod
string (BooleanFilterParam)

Filter by contracts within notice period alert day(s)

Example: noticePeriod=true | false
filter
string (StringFilterParam)

Filter by text (Name, Assignment Level, Profile Name or Roll-over Profile Name)

Example: filter=xyz | in:x,y | like:xyz
includeSupersededVersions
string (BooleanFilterParam)

Filter to include superseded i.e. old versions of the customer contract

Example: includeSupersededVersions=true | false
recentWithRPIsOrFuture
string (BooleanFilterParam)

If true, then return only customer contracts associated to RPIs that are 'recent', or customer contracts starting in the future.

Example: recentWithRPIsOrFuture=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",
    • "customerId": 0,
    • "siteId": 0,
    • "contractProfileId": 0,
    • "startDate": "2019-08-24",
    • "endDate": "2019-08-24",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "rolloverContractProfileId": 0,
    • "renewalAlertDays": 28,
    • "noticePeriodDays": 2147483647,
    • "previousCustomerContractId": 0,
    • "renewedCustomerContractId": 0
    }
]