Apideck.IssueTracking

Class Name

IssueTrackingApi

Methods

List Tags
Create Comment
List Comments
Delete Comment
Get Comment
Update Comment
Create Ticket
List Tickets
Delete Ticket
Get Ticket
Update Ticket
List Users
Get User
List Collections
Get Collection

List Tags

Method: collectionTagsAll

Apideck->getIssueTrackingApi()->collectionTagsAll($data)

Parameters

Name	Type	Description	Notes
collection_id	string	The collection ID
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetCollectionTagsResponse

HTTP response details

Status code	Description
200	List Tags
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTagsAll('collection_id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Create Comment

Method: collectionTicketCommentsAdd

Apideck->getIssueTrackingApi()->collectionTicketCommentsAdd($data)

Parameters

Name	Type	Description	Notes
collection_id	string	The collection ID
ticket_id	string	ID of the ticket you are acting upon.
collection_ticket_comment	\Apideck\Client\Model\CollectionTicketComment
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateCommentResponse

HTTP response details

Status code	Description
201	Create a Comment
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTicketCommentsAdd('collection_id_example', 'ticket_id_example', $collectionTicketComment);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

List Comments

Method: collectionTicketCommentsAll

Apideck->getIssueTrackingApi()->collectionTicketCommentsAll($data)

Parameters

Name	Type	Description	Notes
collection_id	string	The collection ID
ticket_id	string	ID of the ticket you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
sort	\Apideck\Client\Model\CommentsSort	Apply sorting
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetCommentsResponse

HTTP response details

Status code	Description
200	List Comments
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTicketCommentsAll('collection_id_example', 'ticket_id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Delete Comment

Method: collectionTicketCommentsDelete

Apideck->getIssueTrackingApi()->collectionTicketCommentsDelete($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
collection_id	string	The collection ID
ticket_id	string	ID of the ticket you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteCommentResponse

HTTP response details

Status code	Description
200	Delete a Comment
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTicketCommentsDelete('id_example', 'collection_id_example', 'ticket_id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Get Comment

Method: collectionTicketCommentsOne

Apideck->getIssueTrackingApi()->collectionTicketCommentsOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
collection_id	string	The collection ID
ticket_id	string	ID of the ticket you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetCommentResponse

HTTP response details

Status code	Description
200	Get a Comment
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTicketCommentsOne('id_example', 'collection_id_example', 'ticket_id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Update Comment

Method: collectionTicketCommentsUpdate

Apideck->getIssueTrackingApi()->collectionTicketCommentsUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
collection_id	string	The collection ID
ticket_id	string	ID of the ticket you are acting upon.
collection_ticket_comment	\Apideck\Client\Model\CollectionTicketComment
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateCommentResponse

HTTP response details

Status code	Description
200	Update a Comment
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTicketCommentsUpdate('id_example', 'collection_id_example', 'ticket_id_example', $collectionTicketComment);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Create Ticket

Method: collectionTicketsAdd

Apideck->getIssueTrackingApi()->collectionTicketsAdd($data)

Parameters

Name	Type	Description	Notes
collection_id	string	The collection ID
ticket	\Apideck\Client\Model\Ticket
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateTicketResponse

HTTP response details

Status code	Description
201	Create a Ticket
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTicketsAdd('collection_id_example', $collectionTicket);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

List Tickets

Method: collectionTicketsAll

Apideck->getIssueTrackingApi()->collectionTicketsAll($data)

Parameters

Name	Type	Description	Notes
collection_id	string	The collection ID
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
sort	\Apideck\Client\Model\TicketsSort	Apply sorting
filter	\Apideck\Client\Model\IssuesFilter	Apply filters
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetTicketsResponse

HTTP response details

Status code	Description
200	List Tickets
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTicketsAll('collection_id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Delete Ticket

Method: collectionTicketsDelete

Apideck->getIssueTrackingApi()->collectionTicketsDelete($data)

Parameters

Name	Type	Description	Notes
ticket_id	string	ID of the ticket you are acting upon.
collection_id	string	The collection ID
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteTicketResponse

HTTP response details

Status code	Description
200	Delete a Ticket
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTicketsDelete('ticket_id_example', 'collection_id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Get Ticket

Method: collectionTicketsOne

Apideck->getIssueTrackingApi()->collectionTicketsOne($data)

Parameters

Name	Type	Description	Notes
ticket_id	string	ID of the ticket you are acting upon.
collection_id	string	The collection ID
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetTicketResponse

HTTP response details

Status code	Description
200	Get a Ticket
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTicketsOne('ticket_id_example', 'collection_id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Update Ticket

Method: collectionTicketsUpdate

Apideck->getIssueTrackingApi()->collectionTicketsUpdate($data)

Parameters

Name	Type	Description	Notes
ticket_id	string	ID of the ticket you are acting upon.
collection_id	string	The collection ID
ticket	\Apideck\Client\Model\Ticket
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateTicketResponse

HTTP response details

Status code	Description
200	Update a Ticket
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionTicketsUpdate('ticket_id_example', 'collection_id_example', $collectionTicket);
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

List Users

Method: collectionUsersAll

Apideck->getIssueTrackingApi()->collectionUsersAll($data)

Parameters

Name	Type	Description	Notes
collection_id	string	The collection ID
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetCollectionUsersResponse

HTTP response details

Status code	Description
200	Users
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionUsersAll('collection_id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Get User

Method: collectionUsersOne

Apideck->getIssueTrackingApi()->collectionUsersOne($data)

Parameters

Name	Type	Description	Notes
collection_id	string	The collection ID
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetCollectionUserResponse

HTTP response details

Status code	Description
200	User
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionUsersOne('collection_id_example', 'id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

List Collections

Method: collectionsAll

Apideck->getIssueTrackingApi()->collectionsAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
sort	\Apideck\Client\Model\CollectionsSort	Apply sorting
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\GetCollectionsResponse

HTTP response details

Status code	Description
200	List Collections
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionsAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Get Collection

Method: collectionsOne

Apideck->getIssueTrackingApi()->collectionsOne($data)

Parameters

Name	Type	Description	Notes
collection_id	string	The collection ID
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	string	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
fields	string	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\GetCollectionResponse

HTTP response details

Status code	Description
200	Get a Collection
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getIssueTrackingApi()->collectionsOne('collection_id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[Back to top] [Back to API list] [Back to README]

Files

IssueTrackingApi.md

Latest commit

History

IssueTrackingApi.md

File metadata and controls

Apideck.IssueTracking

Class Name

Methods

List Tags

Parameters

Response Type

HTTP response details

Example Usage

Create Comment

Parameters

Response Type

HTTP response details

Example Usage

List Comments

Parameters

Response Type

HTTP response details

Example Usage

Delete Comment

Parameters

Response Type

HTTP response details

Example Usage

Get Comment

Parameters

Response Type

HTTP response details

Example Usage

Update Comment

Parameters

Response Type

HTTP response details

Example Usage

Create Ticket

Parameters

Response Type

HTTP response details

Example Usage

List Tickets

Parameters

Response Type

HTTP response details

Example Usage

Delete Ticket

Parameters

Response Type

HTTP response details

Example Usage

Get Ticket

Parameters

Response Type

HTTP response details

Example Usage

Update Ticket

Parameters

Response Type

HTTP response details

Example Usage

List Users

Parameters

Response Type

HTTP response details

Example Usage

Get User

Parameters

Response Type

HTTP response details

Example Usage

List Collections

Parameters

Response Type

HTTP response details

Example Usage

Get Collection