| Keywords: |
|
|
Gemini Community Support Site
This Gemini community support site can be used to find solutions to product issues. You can log in using Open Id, Google Profile and even Facebook. Feel free to ask a question or browse FAQs and documentation. Product tour videos are also available along with how-to videos demonstrating key Gemini capabilities. |
| 10.12 |
|
API |
api
|
|
| 10.12.1 |
|
Introduction |
api
|
|
| 10.12.2 |
|
Enabling API support |
install
api
|
|
| 10.12.3 |
|
Authentication |
api
|
|
| 10.12.4 |
|
Response Formats |
api
|
|
| 10.12.5 |
|
.NET Quick-start |
api
|
|
| 10.12.6 |
|
Schema Reference |
api
|
|
| 10.12.7 |
|
Administration API |
admin
api
|
|
| 10.12.8 |
|
Alerts API |
api
emails
|
|
| 10.12.9 |
|
Custom Fields API |
custom-fields
api
|
|
| 10.12.10 |
|
Groups API |
security
api
|
|
| 10.12.11 |
|
Items API |
api
|
|
| 10.12.12 |
|
Projects API |
projects
api
|
|
| 10.12.13 |
|
Users API |
security
api
|
|
| 10.12.14 |
|
Testing API |
testing
api
|
|
15 documents found.
Projects API
Projects
Get Projects
| REST End-point | GET /api/projects.ashx/projects |
| Client API Method | ProjectsService.GetProjects |
| Request Body |
Fetch all Project. Returns an array of ProjectEN objects.
Get Project
| REST End-point | GET /api/projects.ashx/projects/{projectId} |
| Client API Method | ProjectsService.GetProject |
| Request Body |
Returns ProjectEN based upon provided Project Id.
Get Project
| REST End-point | GET /api/projects.ashx/projects/code/{projectId} |
| Client API Method | ProjectsService.GetProject |
| Request Body |
Returns ProjectEN based upon provided Project Code
Create Project
| REST End-point | POST /api/projects.ashx/projects |
| Client API Method | ProjectsService.CreateProject |
| Request Body | ProjectEN |
Creates new Project based upon provided ProjectEN object.
Returns a ProjectEN object that will contain new Project Id.
Update Project
| REST End-point | PUT /api/projects.ashx/projects/{projectId} |
| Client API Method | ProjectsService.UpdateProject |
| Request Body | ProjectEN |
Updates an existing ProjectEN object.
Returns the updated ProjectEN object.
Delete Project
| REST End-point | DELETE /api/projects.ashx/projects/{projectId} |
| Client API Method | ProjectsService.DeleteProject |
| Request Body |
Deletes an existing ProjectEN object.
Components
Get Components
| REST End-point | GET /api/projects.ashx/projects/{projectId}/components |
| Client API Method | ProjectsService.GetComponents |
| Request Body |
Fetch all Project Components. Returns an array of ComponentEN objects.
Get Component
| REST End-point | GET /api/projects.ashx/projects/{projectId}/components/{componentId} |
| Client API Method | ProjectsService.GetComponent |
| Request Body |
Returns ComponentEN based upon provided Component Id.
Create Component
| REST End-point | POST /api/projects.ashx/projects/{projectId}/components |
| Client API Method | ProjectsService.CreateComponent |
| Request Body | ComponentEN |
Creates new Project Component based upon provided ComponentEN object.
Returns a ComponentEN object that will contain new Component Id.
Update Component
| REST End-point | PUT /api/projects.ashx/projects/{projectId}/components/{componentId} |
| Client API Method | ProjectsService.UpdateComponent |
| Request Body | ComponentEN |
Updates an existing ComponentEN object.
Returns the updated ComponentEN object.
Delete Component
| REST End-point | DELETE /api/projects.ashx/projects/{projectId}/components/{componentId} |
| Client API Method | ProjectsService.DeleteComponent |
| Request Body |
Deletes an existing ComponentEN object.
Versions
Get Versions
| REST End-point | GET /api/projects.ashx/projects/{projectId}/versions |
| Client API Method | ProjectsService.GetVersions |
| Request Body |
Fetch all Project Version. Returns an array of VersionEN objects.
Get Version
| REST End-point | GET /api/projects.ashx/projects/{projectId}/versions/{versionId} |
| Client API Method | ProjectsService.GetVersion |
| Request Body |
Returns VersionEN based upon provided Version Id.
Create Version
| REST End-point | POST /api/projects.ashx/projects/{projectId}/versions |
| Client API Method | ProjectsService.CreateVersion |
| Request Body | VersionEN |
Creates new Project Version based upon provided VersionEN object.
Returns a VersionEN object that will contain new Version Id.
Update Version
| REST End-point | PUT /api/projects.ashx/projects/{projectId}/versions/{versionId} |
| Client API Method | ProjectsService.UpdateVersion |
| Request Body | VersionEN |
Updates an existing VersionEN object.
Returns the updated VersionEN object.
Delete Version
| REST End-point | DELETE /api/projects.ashx/projects/{projectId}/versions/{versionId} |
| Client API Method | ProjectsService.DeleteVersion |
| Request Body |
Deletes an existing VersionEN object.
Project Attributes
Get Project Attributes
| REST End-point | GET /api/projects.ashx/projects/{projectId}/attributes |
| Client API Method | ProjectsService.GetProjectAttributes |
| Request Body |
Fetch all Project Attribute. Returns an array of ProjectAttributeEN objects.
Get Project Attribute
| REST End-point | GET /api/projects.ashx/projects/{projectId}/attributes/{attributeId} |
| Client API Method | ProjectsService.GetProjectAttribute |
| Request Body |
Returns ProjectAttributeEN based upon provided Attribute Id.
Create Project Attribute
| REST End-point | POST /api/projects.ashx/projects/{projectId}/attributes |
| Client API Method | ProjectsService.CreateProjectAttribute |
| Request Body | ProjectAttributeEN |
Creates new Project Attribute based upon provided ProjectAttributeEN object.
Returns a ProjectAttributeEN object that will contain new Attribute Id.
Update Project Attribute
| REST End-point | PUT /api/projects.ashx/projects/{projectId}/attributes/{attributeId} |
| Client API Method | ProjectsService.UpdateProjectAttribute |
| Request Body | ProjectAttributeEN |
Updates an existing ProjectAttributeEN object.
Returns the updated ProjectAttributeEN object.
Delete Project Attribute
| REST End-point | DELETE /api/projects.ashx/projects/{projectId}/attributes/{attributeId} |
| Client API Method | ProjectsService.DeleteProjectAttribute |
| Request Body |
Deletes an existing ProjectAttributeEN object.
Version Attributes
Get Version Attributes
| REST End-point | GET /api/projects.ashx/projects/{projectId}/versionattributes |
| Client API Method | ProjectsService.GetProjectVersionAttributes |
| Request Body |
Fetch all Version Attribute. Returns an array of ProjectVersionAttributeEN objects.
Get Version Attribute
| REST End-point | GET /api/projects.ashx/projects/{projectId}/versionattributes/{attributeId} |
| Client API Method | ProjectsService.GetProjectVersionAttribute |
| Request Body |
Returns ProjectVersionAttributeEN based upon provided Attribute Id.
Create Version Attribute
| REST End-point | POST /api/projects.ashx/projects/{projectId}/versionattributes |
| Client API Method | ProjectsService.CreateProjectVersionAttribute |
| Request Body | ProjectVersionAttributeEN |
Creates new Version Attribute based upon provided ProjectVersionAttributeEN object.
Returns a ProjectVersionAttributeEN object that will contain new Attribute Id.
Update Version Attribute
| REST End-point | PUT /api/projects.ashx/projects/{projectId}/versionattributes/{attributeId} |
| Client API Method | ProjectsService.UpdateProjectVersionAttribute |
| Request Body | ProjectVersionAttributeEN |
Updates an existing ProjectVersionAttributeEN object.
Returns the updated ProjectVersionAttributeEN object.
Delete Version Attribute
| REST End-point | DELETE /api/projects.ashx/projects/{projectId}/versionattributes/{attributeId} |
| Client API Method | ProjectsService.DeleteProjectVersionAttribute |
| Request Body |
Deletes an existing ProjectVersionAttributeEN object.
Get Version Attribute Values
| REST End-point | GET /api/projects.ashx/projects/{projectId}/versions/{1}/versionattributevalues |
| Client API Method | ProjectsService.GetProjectVersionAttributeValues |
| Request Body |
Fetch all Version Attribute Values. Returns an array of VersionAttributeValueEN objects.
Get Version Attribute Value
| REST End-point | GET /api/projects.ashx/projects/{projectId}/versions/{1}/versionattributevalues/{attributeId} |
| Client API Method | ProjectsService.GetProjectVersionAttributeValue |
| Request Body |
Returns VersionAttributeValueEN based upon provided Attribute Id.
Create Version Attribute Value
| REST End-point | POST /api/projects.ashx/{projectId}/versions/{1}/versionattributevalues |
| Client API Method | ProjectsService.CreateProjectVersionAttributeValue |
| Request Body | VersionAttributeValueEN |
Creates new Version Attribute Values based upon provided VersionAttributeValueEN object.
Returns a VersionAttributeValueEN object that will contain new Attribute Id.
Update Version Attribute Value
| REST End-point | PUT /api/projects.ashx/projects/{projectId}/versions/{1}/versionattributevalues/{attributeId} |
| Client API Method | ProjectsService.UpdateProjectVersionAttributeValue |
| Request Body | VersionAttributeValueEN |
Updates an existing VersionAttributeValueEN object.
Returns the updated VersionAttributeValueEN object.
Delete Version Attribute Value
| REST End-point | DELETE /api/projects.ashx/projects/{projectId}/versions/{1}/versionattributevalues/{attributeId} |
| Client API Method | ProjectsService.DeleteProjectVersionAttributeValue |
| Request Body |
Deletes an existing VersionAttributeValueEN object.
Default Values
Get Default Values
| REST End-point | GET /api/projects.ashx/projects/{projectId}/defaults |
| Client API Method | ProjectsService.GetProjectDefaultValues |
| Request Body |
Fetch all Project Default Values. Returns an array of ProjectDefaultValueEN objects.
Custom Fields
Get Custom Fields
| REST End-point | GET /api/projects.ashx/projects/{projectId}/customfields |
| Client API Method | ProjectsService.GetProjectCustomFields |
| Request Body |
Fetch all Project Custom Fields. Returns an array of CustomFieldEN objects.
Resources
Get Project Resources
| REST End-point | GET /api/projects.ashx/projects/{projectId}/resources |
| Client API Method | ProjectsService.GetProjectResources |
| Request Body |
Fetch all Project Resources. Returns an array of UserEN objects.
Roadmap
Get Project Roadmap
| REST End-point | GET /api/projects.ashx/projects/{projectId}/roadmap |
| Client API Method | ProjectsService.GetProjectRoadMap |
| Request Body |
Fetch all Issues that make up the Project Roadmap. Returns an array of IssueEN objects.
Change Log
Get Project Change Log
| REST End-point | GET /api/projects.ashx/projects/{projectId}/changelog |
| Client API Method | ProjectsService.GetProjectChangeLog |
| Request Body |
Fetch all Issues that make up the Project Change Log. Returns an array of IssueEN objects.
Documents
Get Documents
| REST End-point | GET /api/projects.ashx/projects/{projectId}/documents |
| Client API Method | ProjectsService.GetDocuments |
| Request Body |
Fetch all Project Documents. Returns an array of DocumentEN objects.
Get Document
| REST End-point | GET /api/projects.ashx/projects/{projectId}/documents/{documentId} |
| Client API Method | ProjectsService.GetDocument |
| Request Body |
Returns DocumentEN based upon provided Document Id.
Create Document
| REST End-point | POST /api/projects.ashx/projects/{projectId}/documents |
| Client API Method | ProjectsService.CreateDocument |
| Request Body | DocumentEN |
Creates new Project Document based upon provided DocumentEN object.
Returns a DocumentEN object that will contain new Document Id.
Update Document
| REST End-point | PUT /api/projects.ashx/projects/{projectId}/documents/{documentId} |
| Client API Method | ProjectsService.UpdateDocument |
| Request Body | DocumentEN |
Updates an existing DocumentEN object.
Returns the updated DocumentEN object.
Delete Document
| REST End-point | DELETE /api/projects.ashx/projects/{projectId}/documents/{documentId} |
| Client API Method | ProjectsService.DeleteDocument |
| Request Body |
Deletes an existing DocumentEN object.
Schedule \ Appointments
Get Appointments
| REST End-point | GET /api/projects.ashx/projects/{projectId}/user/{userId}/startdate/{date-value}/enddate/{date-value}/schedule |
| Client API Method | ProjectsService.GetAppointments |
| Request Body |
Fetch all Project Appointments for a given user between a given date range. Returns an array of AppointmentEN objects.
Date values must be specified in the 'yyyy-MM-dd' format
Get Appointment
| REST End-point | GET /api/projects.ashx/projects/{projectId}/schedule/{appointmentId} |
| Client API Method | ProjectsService.GetAppointment |
| Request Body |
Returns AppointmentEN based upon provided Appointment Id.
Create Appointment
| REST End-point | POST /api/projects.ashx/projects/{projectId}/schedule |
| Client API Method | ProjectsService.CreateAppointment |
| Request Body | AppointmentEN |
Creates new Project Appointment based upon provided AppointmentEN object.
Returns a AppointmentEN object that will contain new Appointment Id.
Update Appointment
| REST End-point | PUT /api/projects.ashx/projects/{projectId}/schedule/{appointmentId} |
| Client API Method | ProjectsService.UpdateAppointment |
| Request Body | AppointmentEN |
Updates an existing AppointmentEN object.
Returns the updated AppointmentEN object.
Delete Appointment
| REST End-point | DELETE /api/projects.ashx/projects/{projectId}/schedule/{appointmentId} |
| Client API Method | ProjectsService.DeleteAppointment |
| Request Body |
Deletes an existing AppointmentEN object.
Meta-data
Get Project Workflow
| REST End-point | GET /api/projects.ashx/projects/{projectId}/workflow |
| Client API Method | ProjectsService.GetWorkflow |
| Request Body |
Returns IssueWorkflowEN for the specified Project.
Workflow details how an Issue transitions between the various Issue Status items.
Get Project Field Visibility Scheme
| REST End-point | GET /api/projects.ashx/projects/{projectId}/fieldvisibility |
| Client API Method | ProjectsService.GetFieldVisibilityScheme |
| Request Body |
Returns FieldVisibilitySchemeEN for the specified Project.
Field Visibility Scheme details which Issue Fields are visible to which users/groups when displaying the Projects' Issues grid.
Get Project Issue Priority Values
| REST End-point | GET /api/projects.ashx/projects/{projectId}/priorities |
| Client API Method | ProjectsService.GetPriorities |
| Request Body |
Returns all Issue Priority values used by the specified Project.
Returns an array of IssuePriorityEN objects.
Get Project Issue Severity Values
| REST End-point | GET /api/projects.ashx/projects/{projectId}/severities |
| Client API Method | ProjectsService.GetSeverities |
| Request Body |
Returns all Issue Severity values used by the specified Project.
Returns an array of IssueSeverityEN objects.
Get Project Issue Type Values
| REST End-point | GET /api/projects.ashx/projects/{projectId}/types |
| Client API Method | ProjectsService.GetTypes |
| Request Body |
Returns all Issue Type values used by the specified Project.
Returns an array of IssueTypeEN objects.