All URIs are relative to https://api.insightly.com/v3.0
Method | HTTP request | Description |
---|---|---|
addActivitySetAssignment | POST /Projects/{id}/ActivitySetAssignment | Adds an Activity Set to a Project |
addEntity | POST /Projects | Adds a Project |
addFileAttachment | POST /Projects/{id}/FileAttachments | Adds a File Attachment to a Project |
addFollow | POST /Projects/{id}/Follow | Start following a Project |
addLink | POST /v3.0/Projects/{id}/Links | Adds a Link |
addMilestone | POST /v3.0/Projects/{id}/Milestones | Adds a Milestone |
addNotes | POST /Projects/{id}/Notes | Adds a Note to a Project |
addTag | POST /Projects/{id}/Tags | Adds a Tag |
deleteEntity | DELETE /Projects/{id} | Deletes a Project |
deleteFollow | DELETE /Projects/{id}/Follow | Stop following a Project |
deleteImage | DELETE /Projects/{id}/Image | Deletes a Project's Image |
deleteLink | DELETE /Projects/{id}/Links/{linkId} | Deletes a Link |
deleteMilestone | DELETE /Projects/{id}/Milestones/{milestoneId} | Deletes a Milestone |
deletePipeline | DELETE /Projects/{id}/Pipeline | Clears pipeline for the Project |
deleteTag | DELETE /Projects/{id}/Tags/{tagName} | Deletes a Tag |
getEmails | GET /Projects/{id}/Emails | Gets a list of a Project's Emails |
getEntities | GET /Projects | Gets a list of Projects |
getEntitiesBySearch | GET /Projects/Search | Gets a filtered list of Projects |
getEntitiesByTag | GET /Projects/SearchByTag | Gets a list of Projects filtered by tags |
getEntity | GET /Projects/{id} | Gets a Project |
getEvents | GET /Projects/{id}/Events | Gets a Project's Events |
getFileAttachments | GET /Projects/{id}/FileAttachments | Gets a Project's File Attachments |
getFollow | GET /Projects/{id}/Follow | Gets a Follow state for a Project |
getImage | GET /Projects/{id}/Image | Gets a Project's Image |
getLinkEmailAddress | GET /Projects/{id}/LinkEmailAddress | Gets the email address to use for linking with the Project |
getLinks | GET /v3.0/Projects/{id}/Links | Gets a Project's Links |
getMilestones | GET /v3.0/Projects/{id}/Milestones | Gets a list of a Project's Milestones |
getNotes | GET /Projects/{id}/Notes | Gets a Project's Notes |
getTasks | GET /Projects/{id}/Tasks | Gets a list of a Project's Tasks |
updateEntity | PUT /Projects | Updates a Project |
updateImage | PUT /Projects/{id}/Image/{filename} | Updates a Project's Image |
updateLink | PUT /v3.0/Projects/{id}/Links | Updates a Link |
updateMilestone | PUT /v3.0/Projects/{id}/Milestones | Updates a Milestone |
updateNotes | PUT /Projects/{id}/Notes | Updates a note of a Project |
updatePipeline | PUT /Projects/{id}/Pipeline | Changes current pipeline for the Project |
updatePipelineStage | PUT /Projects/{id}/PipelineStage | Changes current pipeline stage for the Project |
\Swagger\Client\Model\APIActivitySetAssignment addActivitySetAssignment($id, $authorization, $api_activity_set_assignment)
Adds an Activity Set to a Project
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_activity_set_assignment = new \Swagger\Client\Model\APIActivitySetAssignment(); // \Swagger\Client\Model\APIActivitySetAssignment | The Activity Set Assignment object which contains the configuration information for the Activity Set (just include JSON object as request body)
try {
$result = $apiInstance->addActivitySetAssignment($id, $authorization, $api_activity_set_assignment);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->addActivitySetAssignment: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
api_activity_set_assignment | \Swagger\Client\Model\APIActivitySetAssignment | The Activity Set Assignment object which contains the configuration information for the Activity Set (just include JSON object as request body) |
\Swagger\Client\Model\APIActivitySetAssignment
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Project addEntity($authorization, $field_values)
Adds a Project
If you have trouble with creating a Project, try creating Projects via the web interface, and then access those Projects via the API. This way you can see examples of the fields and sub-elements attached to the Project. A common source of problems during write/update request is caused when users omit required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \Swagger\Client\Model\Project2(); // \Swagger\Client\Model\Project2 | The record to add (just include the JSON object as the request body)
try {
$result = $apiInstance->addEntity($authorization, $field_values);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->addEntity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
authorization | string | Authorization | [default to {{Authorization}}] |
field_values | \Swagger\Client\Model\Project2 | The record to add (just include the JSON object as the request body) |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIFileAttachment addFileAttachment($id, $file, $authorization, $file_name, $content_type, $file_category_id)
Adds a File Attachment to a Project
This endpoint expects multipart/form-data as the request payload. See Stack Overflow for examples of how to generate multipart requests, or see our <a href="http://github.com/Insightly\" target="_blank">client libraries for an example of how this is generated. Only one file can be added per request.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | Record ID
$file = "/path/to/file.txt"; // \SplFileObject | The file part of the multipart/form-data request. Only one file can be added per request.
$authorization = "{{Authorization}}"; // string | Authorization
$file_name = "file_name_example"; // string |
$content_type = "content_type_example"; // string |
$file_category_id = 56; // int |
try {
$result = $apiInstance->addFileAttachment($id, $file, $authorization, $file_name, $content_type, $file_category_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->addFileAttachment: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | Record ID | |
file | \SplFileObject | The file part of the multipart/form-data request. Only one file can be added per request. | |
authorization | string | Authorization | [default to {{Authorization}}] |
file_name | string | [optional] | |
content_type | string | [optional] | |
file_category_id | int | [optional] |
\Swagger\Client\Model\APIFileAttachment
No authorization required
- Content-Type: multipart/form-data
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIFollow addFollow($id, $authorization)
Start following a Project
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->addFollow($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->addFollow: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID (RECORD_ID) | |
authorization | string | Authorization | [default to {{Authorization}}] |
\Swagger\Client\Model\APIFollow
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APILinkDto addLink($id, $authorization, $api_link)
Adds a Link
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$api_link = new \Swagger\Client\Model\APILinkDto(); // \Swagger\Client\Model\APILinkDto | The Link to add (just include JSON object as request body)
try {
$result = $apiInstance->addLink($id, $authorization, $api_link);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->addLink: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID (RECORD_ID) | |
authorization | string | Authorization | [default to {{Authorization}}] |
api_link | \Swagger\Client\Model\APILinkDto | The Link to add (just include JSON object as request body) |
\Swagger\Client\Model\APILinkDto
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIMilestone[] addMilestone($id, $authorization, $api_milestone)
Adds a Milestone
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_milestone = new \Swagger\Client\Model\APIMilestone(); // \Swagger\Client\Model\APIMilestone | The milestone to add (just include JSON object as request body)
try {
$result = $apiInstance->addMilestone($id, $authorization, $api_milestone);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->addMilestone: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
api_milestone | \Swagger\Client\Model\APIMilestone | The milestone to add (just include JSON object as request body) |
\Swagger\Client\Model\APIMilestone[]
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APINote addNotes($id, $authorization, $field_values)
Adds a Note to a Project
If you have trouble with creating a Project, try creating Projects via the web interface, and then access those Projects via the API. This way you can see examples of the fields and sub-elements attached to the Project. A common source of problems during write/update request is caused when users omit required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \Swagger\Client\Model\APINote(); // \Swagger\Client\Model\APINote | The record to add (just include the JSON object as the request body)
try {
$result = $apiInstance->addNotes($id, $authorization, $field_values);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->addNotes: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID (RECORD_ID) | |
authorization | string | Authorization | [default to {{Authorization}}] |
field_values | \Swagger\Client\Model\APINote | The record to add (just include the JSON object as the request body) |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APITag addTag($id, $authorization, $api_tag)
Adds a Tag
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_tag = new \Swagger\Client\Model\APITag(); // \Swagger\Client\Model\APITag | The Tag to add (just include the JSON object as the request body)
try {
$result = $apiInstance->addTag($id, $authorization, $api_tag);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->addTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | The record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
api_tag | \Swagger\Client\Model\APITag | The Tag to add (just include the JSON object as the request body) |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteEntity($id, $authorization)
Deletes a Project
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | Entity's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteEntity($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->deleteEntity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | Entity's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteFollow($id, $authorization)
Stop following a Project
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteFollow($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->deleteFollow: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID (RECORD_ID) | |
authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteImage($id, $authorization)
Deletes a Project's Image
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteImage($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->deleteImage: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteLink($id, $link_id, $authorization)
Deletes a Link
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$link_id = 789; // int | A Link's ID (LINK_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteLink($id, $link_id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->deleteLink: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID (RECORD_ID) | |
link_id | int | A Link's ID (LINK_ID) | |
authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteMilestone($id, $milestone_id, $authorization)
Deletes a Milestone
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$milestone_id = 789; // int | A Milestone's ID (MILESTONE_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteMilestone($id, $milestone_id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->deleteMilestone: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
milestone_id | int | A Milestone's ID (MILESTONE_ID) | |
authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deletePipeline($id, $authorization)
Clears pipeline for the Project
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deletePipeline($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->deletePipeline: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteTag($id, $tag_name, $authorization)
Deletes a Tag
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$tag_name = "tag_name_example"; // string | A Tag's name
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteTag($id, $tag_name, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->deleteTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | The record's ID | |
tag_name | string | A Tag's name | |
authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIEmail[] getEmails($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a list of a Project's Emails
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when email was last updated.
$top = 56; // int | Optional, maximum number of emails to return.
$skip = 56; // int | Optional, number of emails to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEmails($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getEmails: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
updated_after_utc | \DateTime | Optional, earliest date when email was last updated. | [optional] |
top | int | Optional, maximum number of emails to return. | [optional] |
skip | int | Optional, number of emails to skip. | [optional] |
brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\Swagger\Client\Model\APIEmail[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] getEntities($authorization, $brief, $skip, $top, $count_total)
Gets a list of Projects
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional,true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEntities($authorization, $brief, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getEntities: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
authorization | string | Authorization | [default to {{Authorization}}] |
brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
skip | int | Optional, number of records to skip. | [optional] |
top | int | Optional, maximum number of records to return in the response. | [optional] |
count_total | bool | Optional,true if total number of records should be returned in the response headers. | [optional] [default to false] |
object[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] getEntitiesBySearch($authorization, $field_name, $field_value, $brief, $skip, $top, $count_total)
Gets a filtered list of Projects
To filter with a field name and value, both field_name and field_value parameters must be provided.
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_name = "field_name_example"; // string | Optional, field name for object
$field_value = "field_value_example"; // string | Optional, field value of the record
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional, true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEntitiesBySearch($authorization, $field_name, $field_value, $brief, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getEntitiesBySearch: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
authorization | string | Authorization | [default to {{Authorization}}] |
field_name | string | Optional, field name for object | [optional] |
field_value | string | Optional, field value of the record | [optional] |
brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
skip | int | Optional, number of records to skip. | [optional] |
top | int | Optional, maximum number of records to return in the response. | [optional] |
count_total | bool | Optional, true if total number of records should be returned in the response headers. | [optional] [default to false] |
object[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] getEntitiesByTag($tag_name, $authorization, $brief, $skip, $top, $count_total)
Gets a list of Projects filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$tag_name = "tag_name_example"; // string | Tag name to filter on
$authorization = "{{Authorization}}"; // string | Authorization
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional, true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEntitiesByTag($tag_name, $authorization, $brief, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getEntitiesByTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
tag_name | string | Tag name to filter on | |
authorization | string | Authorization | [default to {{Authorization}}] |
brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
skip | int | Optional, number of records to skip. | [optional] |
top | int | Optional, maximum number of records to return in the response. | [optional] |
count_total | bool | Optional, true if total number of records should be returned in the response headers. | [optional] [default to false] |
object[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Project getEntity($id, $authorization)
Gets a Project
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getEntity($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getEntity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | The record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIEvent[] getEvents($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a Project's Events
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when event was last updated.
$top = 56; // int | Optional, maximum number of events to return.
$skip = 56; // int | Optional, number of events to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEvents($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getEvents: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
updated_after_utc | \DateTime | Optional, earliest date when event was last updated. | [optional] |
top | int | Optional, maximum number of events to return. | [optional] |
skip | int | Optional, number of events to skip. | [optional] |
brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\Swagger\Client\Model\APIEvent[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIFileAttachment[] getFileAttachments($id, $authorization, $updated_after_utc, $skip, $top, $count_total)
Gets a Project's File Attachments
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when file attachment was last updated.
$skip = 56; // int | Optional, number of file attachments to skip.
$top = 56; // int | Optional, maximum number of file attachments to return in the response.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getFileAttachments($id, $authorization, $updated_after_utc, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getFileAttachments: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
updated_after_utc | \DateTime | Optional, earliest date when file attachment was last updated. | [optional] |
skip | int | Optional, number of file attachments to skip. | [optional] |
top | int | Optional, maximum number of file attachments to return in the response. | [optional] |
count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\Swagger\Client\Model\APIFileAttachment[]
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIFollow getFollow($id, $authorization)
Gets a Follow state for a Project
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getFollow($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getFollow: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A record's ID (RECORD_ID) | |
authorization | string | Authorization | [default to {{Authorization}}] |
\Swagger\Client\Model\APIFollow
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getImage($id, $authorization)
Gets a Project's Image
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->getImage($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getImage: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APILinkEmailAddress getLinkEmailAddress($id, $authorization)
Gets the email address to use for linking with the Project
An email address to use as a maildrop for the Project.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getLinkEmailAddress($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getLinkEmailAddress: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
\Swagger\Client\Model\APILinkEmailAddress
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APILinkDto[] getLinks($id, $authorization)
Gets a Project's Links
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getLinks($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getLinks: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
\Swagger\Client\Model\APILinkDto[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIMilestone[] getMilestones($id, $authorization)
Gets a list of a Project's Milestones
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getMilestones($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getMilestones: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
\Swagger\Client\Model\APIMilestone[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APINote[] getNotes($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a Project's Notes
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when note was last updated.
$top = 56; // int | Optional, maximum number of notes to return.
$skip = 56; // int | Optional, number of notes to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getNotes($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getNotes: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID (RECORD_ID) | |
authorization | string | Authorization | [default to {{Authorization}}] |
updated_after_utc | \DateTime | Optional, earliest date when note was last updated. | [optional] |
top | int | Optional, maximum number of notes to return. | [optional] |
skip | int | Optional, number of notes to skip. | [optional] |
brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\Swagger\Client\Model\APINote[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APITask[] getTasks($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a list of a Project's Tasks
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when task was last updated.
$top = 56; // int | Optional, maximum number of tasks to return.
$skip = 56; // int | Optional, number of tasks to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getTasks($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->getTasks: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
updated_after_utc | \DateTime | Optional, earliest date when task was last updated. | [optional] |
top | int | Optional, maximum number of tasks to return. | [optional] |
skip | int | Optional, number of tasks to skip. | [optional] |
brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\Swagger\Client\Model\APITask[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Project updateEntity($authorization, $field_values)
Updates a Project
If you have trouble updating a Project, try accessing the Project via the GET request to inspect its fields and sub-elements. A common source of problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a CATEGORY_ID or LINK_ID which does not exist.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \Swagger\Client\Model\Project1(); // \Swagger\Client\Model\Project1 | The record to update (just include the JSON object as the request body)
try {
$result = $apiInstance->updateEntity($authorization, $field_values);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->updateEntity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
authorization | string | Authorization | [default to {{Authorization}}] |
field_values | \Swagger\Client\Model\Project1 | The record to update (just include the JSON object as the request body) |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] updateImage($id, $filename, $authorization, $file)
Updates a Project's Image
This action will replace any existing Image attached to the Project. The contents of the image data should be sent as binary data in the request payload. See our <a href="http://github.com/Insightly\" target="_blank">client libraries for an example of how this is done.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$filename = "filename_example"; // string | Name of Image File to be attached to Record
$authorization = "{{Authorization}}"; // string | Authorization
$file = "B"; // string | File to upload
try {
$result = $apiInstance->updateImage($id, $filename, $authorization, $file);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->updateImage: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
filename | string | Name of Image File to be attached to Record | |
authorization | string | Authorization | [default to {{Authorization}}] |
file | string | File to upload |
object[]
No authorization required
- Content-Type: application/octet-stream
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APILinkDto updateLink($id, $authorization, $api_link)
Updates a Link
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$api_link = new \Swagger\Client\Model\APILinkDto(); // \Swagger\Client\Model\APILinkDto | The Link to add (just include JSON object as request body)
try {
$result = $apiInstance->updateLink($id, $authorization, $api_link);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->updateLink: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID (RECORD_ID) | |
authorization | string | Authorization | [default to {{Authorization}}] |
api_link | \Swagger\Client\Model\APILinkDto | The Link to add (just include JSON object as request body) |
\Swagger\Client\Model\APILinkDto
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIMilestone[] updateMilestone($id, $authorization, $api_milestone)
Updates a Milestone
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_milestone = new \Swagger\Client\Model\APIMilestone(); // \Swagger\Client\Model\APIMilestone | The milestone to add (just include the JSON object as request body)
try {
$result = $apiInstance->updateMilestone($id, $authorization, $api_milestone);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->updateMilestone: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
api_milestone | \Swagger\Client\Model\APIMilestone | The milestone to add (just include the JSON object as request body) |
\Swagger\Client\Model\APIMilestone[]
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APINote updateNotes($id, $authorization, $field_values, $brief)
Updates a note of a Project
If you have trouble updating a Project, try accessing the Project via the GET request to inspect its fields and sub-elements. A common source of problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a CATEGORY_ID or LINK_ID which does not exist.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \Swagger\Client\Model\APINote(); // \Swagger\Client\Model\APINote | The record to update (just include the JSON object as the request body)
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
try {
$result = $apiInstance->updateNotes($id, $authorization, $field_values, $brief);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->updateNotes: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID (RECORD_ID) | |
authorization | string | Authorization | [default to {{Authorization}}] |
field_values | \Swagger\Client\Model\APINote | The record to update (just include the JSON object as the request body) | |
brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIPipelineChange[] updatePipeline($id, $authorization, $api_pipeline_change)
Changes current pipeline for the Project
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_pipeline_change = new \Swagger\Client\Model\APIPipelineChange(); // \Swagger\Client\Model\APIPipelineChange | Pipeline change parameters (just include JSON object as request body)
try {
$result = $apiInstance->updatePipeline($id, $authorization, $api_pipeline_change);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->updatePipeline: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
api_pipeline_change | \Swagger\Client\Model\APIPipelineChange | Pipeline change parameters (just include JSON object as request body) |
\Swagger\Client\Model\APIPipelineChange[]
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIPipelineChange[] updatePipelineStage($id, $authorization, $api_stage_change)
Changes current pipeline stage for the Project
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ProjectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_stage_change = new \Swagger\Client\Model\APIPipelineChange(); // \Swagger\Client\Model\APIPipelineChange | Pipeline stage change parameters (just include JSON object as request body)
try {
$result = $apiInstance->updatePipelineStage($id, $authorization, $api_stage_change);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProjectsApi->updatePipelineStage: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
id | int | A Record's ID | |
authorization | string | Authorization | [default to {{Authorization}}] |
api_stage_change | \Swagger\Client\Model\APIPipelineChange | Pipeline stage change parameters (just include JSON object as request body) |
\Swagger\Client\Model\APIPipelineChange[]
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]