Connectors Reference

Expiration Reminder

Expiration Reminder allows tracking of expiration dates and renewals for software licenses, contracts, employee certifications, permits, warranties, etc.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

FindExpiration ([Optional]string category, [Optional]string email, [Optional]string name, [internal]string Content-Type)

Find expiration

CreateContact ([internal]string Content-Type, CreateContactParameterBody body)

Create contact

RenewExpiration (string expiration_item_id, [internal]string Content-Type, RenewExpirationParameterBody body)

Renew expiration

CreateExpirationItem ([internal]string Content-Type, CreateExpirationItemParameterBody body)

Create expiration item

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

CreateContactParameterBody

 

CreateContactResponse

 

CreateExpirationItemParameterBody

 

CreateExpirationItemResponse

 

FindExpirationResponse

 

RenewExpirationParameterBody

 

RenewExpirationResponse

 

 

Actions:

FindExpiration

Summary: Find expiration

Description: Find an expiration item in Expiration Reminder

 

Syntax:

ExpirationReminder.FindExpiration ([Optional]string category, [Optional]string email, [Optional]string name, [internal]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

category

string

(Category Name)

Specify the category name of the expiration

False

email

string

(Contact Email)

Specify the email of the contact associated with the expiration

False

name

string

(Expiration Name)

Specifiy the expiration name

False

Content-Type

string

 

Content-Type

True

 

Returns:

          Type:FindExpirationResponse

 

CreateContact

Summary: Create contact

Description: Create a new contact in Expiration Reminder

 

Syntax:

ExpirationReminder.CreateContact ([internal]string Content-Type, CreateContactParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

Content-Type

True

body

CreateContactParameterBody

 

 

True

 

Returns:

          Type:CreateContactResponse

 

RenewExpiration

Summary: Renew expiration

Description: Renew an expiration item in Expiration Reminder

 

Syntax:

ExpirationReminder.RenewExpiration (string expiration_item_id, [internal]string Content-Type, RenewExpirationParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

expiration_item_id

string

(Expiration Item ID)

Specify the expiration item ID

True

Content-Type

string

 

Content-Type

True

body

RenewExpirationParameterBody

 

 

True

 

Returns:

          Type:RenewExpirationResponse

 

CreateExpirationItem

Summary: Create expiration item

Description: Create an expiration item in Expiration Reminder

 

Syntax:

ExpirationReminder.CreateExpirationItem ([internal]string Content-Type, CreateExpirationItemParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

CreateExpirationItemParameterBody

 

 

True

 

Returns:

          Type:CreateExpirationItemResponse

 


 

CreateContactParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

name

email

string

 

email


 

CreateContactResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CreateExpirationItemParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

name

category_name

string

 

category_name

expiration_date

string

 

expiration_date


 

CreateExpirationItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

id

name

string

 

name

expiration_date

string(date-time)

 

expiration_date

status

string

 

status

time_of_day

string

 

time_of_day

category

Category

 

category

details

string

 

details

assigned_to

Assigned_to

 

assigned_to

status_id

integer(int32)

 

status_id

modified

string(date-time)

 

modified

category_name

string

 

category_name

 

Category

Summary:

Description: category

 

          Properties:

Name

Type

Summary

name

string

 

category_name

id

string

 

category_id

 

Assigned_to

Summary:

Description: assigned_to

 

          Properties:

Name

Type

Summary

name

string

 

assigned_to_name

email

string

 

email

id

string

 

assigned_to_id

team_id

string

 

team_id

 


 

FindExpirationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

expiration_items

array of (Expiration_itemsItem)

 

expiration_items

pages

integer(int32)

 

pages

page

integer(int32)

 

page

total

integer(int32)

 

total

 

Expiration_itemsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

id

name

string

 

name

expiration_date

string(date-time)

 

expiration_date

status

string

 

status

time_of_day

string

 

time_of_day

category

Category

 

category

details

string

 

details

assigned_to

Assigned_to

 

assigned_to

status_id

integer(int32)

 

status_id

modified

string(date-time)

 

modified

 

Category

Summary:

Description: category

 

          Properties:

Name

Type

Summary

name

string

 

category_name

id

string

 

category_id

 

Assigned_to

Summary:

Description: assigned_to

 

          Properties:

Name

Type

Summary

name

string

 

assigned_to_name

email

string

 

email

id

string

 

assigned_to_id

team_id

string

 

team_id

 


 

RenewExpirationParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

expiration_date

string(date-time)

 

expiration_date

details

string

 

details


 

RenewExpirationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

id

name

string

 

name

expiration_date

string(date-time)

 

expiration_date

status

string

 

status

time_of_day

string

 

time_of_day

category

Category

 

category

details

string

 

details

assigned_to

Assigned_to

 

assigned_to

status_id

integer(int32)

 

status_id

modified

string(date-time)

 

modified

 

Category

Summary:

Description: category

 

          Properties:

Name

Type

Summary

name

string

 

name

id

string

 

id

 

Assigned_to

Summary:

Description: assigned_to

 

          Properties:

Name

Type

Summary

name

string

 

name

email

string

 

email

id

string

 

id

team_id

string

 

team_id