Skip to main content

Agreements

API docs by Redocly

SAM: Agreements (2.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for exploring agreements.

Agreements

Get agreement periods

Returns a collection of periods for a given agreement. You can have multiple periods when one period expires and another is added.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the agreement.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get agreements

Returns a collection of agreements.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get agreement

Returns the details of a given agreement.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the agreement.

Responses

Response samples

Content type
application/json
{
  • "id": "efb6de18-4dbd-4280-94ae-c89de017421f",
  • "parentId": "9ce3536d-603d-48f7-845d-2a61d0ba93b8",
  • "assignedId": "1",
  • "name": "Agr 1",
  • "description": "First agreement",
  • "typeId": "d40935d8-5354-41d8-b5d8-7f06348fc63b",
  • "isSubscription": true,
  • "isUpgradable": true,
  • "isValidForAll": true,
  • "renewalDays": 7,
  • "isAlertingOnExpiration": true,
  • "warningDayLimit": 15,
  • "criticalDayLimit": 7,
  • "isAutoAttachingToComputers": true,
  • "contactId": "db9d81e2-43f8-4ab4-a230-cb995c8d78db",
  • "contactName": "Bill Smith",
  • "contactDepartment": "IT",
  • "contactPhone": "123-456-7890",
  • "contactEmail": "bill.smith@company.com",
  • "manufacturerId": "45558893-9a03-4826-bf8b-ceb5ee479149",
  • "manufacturerName": "Apple",
  • "manufacturerLink": "www.apple.com",
  • "manufacturerPhone": "789-654-1236",
  • "manufacturerContact": "John Smith",
  • "manufacturerContactPhone": "789-654-1237",
  • "manufacturerContactEmail": "john.smith@apple.com",
  • "_links": [
    ]
}

Get agreement types

Returns a collection of agreement types.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get agreement type

Returns the details of a given agreement type.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the agreement type.

Responses

Response samples

Content type
application/json
{
  • "id": "f9ce2c7b-856f-44a3-81f5-ba594a5d20fb",
  • "name": "Software enterprise agreement",
  • "description": "A contract that allows purchase at a discounted, fixed rate for a certain time period.",
  • "_links": [
    ]
}

Contracts

Get contract periods

Returns a collection of periods for a given contract.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the contract.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get contracts

Returns a collection of contracts.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get contract

Returns the details of a given contract.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the contract.

Responses

Response samples

Content type
application/json
{
  • "id": "efb6de18-4dbd-4280-94ae-c89de017421f",
  • "parentId": "9ce3536d-603d-48f7-845d-2a61d0ba93b8",
  • "assignedId": "1",
  • "name": "Agr 1",
  • "description": "First agreement",
  • "typeId": "d40935d8-5354-41d8-b5d8-7f06348fc63b",
  • "isSubscription": true,
  • "isUpgradable": true,
  • "isValidForAll": true,
  • "renewalDays": 7,
  • "isAlertingOnExpiration": true,
  • "warningDayLimit": 15,
  • "criticalDayLimit": 7,
  • "isAutoAttachingToComputers": true,
  • "contactId": "db9d81e2-43f8-4ab4-a230-cb995c8d78db",
  • "contactName": "Bill Smith",
  • "contactDepartment": "IT",
  • "contactPhone": "123-456-7890",
  • "contactEmail": "bill.smith@company.com",
  • "manufacturerId": "45558893-9a03-4826-bf8b-ceb5ee479149",
  • "manufacturerName": "Apple",
  • "manufacturerLink": "www.apple.com",
  • "manufacturerPhone": "789-654-1236",
  • "manufacturerContact": "John Smith",
  • "manufacturerContactPhone": "789-654-1237",
  • "manufacturerContactEmail": "john.smith@apple.com",
  • "_links": [
    ]
}

Get contract types

Returns a collection of contract types.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get contract type

Returns the details of a given contract type.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the contract type.

Responses

Response samples

Content type
application/json
{
  • "id": "f9ce2c7b-856f-44a3-81f5-ba594a5d20fb",
  • "name": "Software enterprise agreement",
  • "description": "A contract that allows purchase at a discounted, fixed rate for a certain time period.",
  • "_links": [
    ]
}