Context
Context is a special type of resource. It contains information about logged user, culture (date, time and number format), selected projects and processes.
You can also use to context to retrieve information about Process details of an entity, as an alternative of requesting Processes collection. For example, to get context for the entity with id = 1424 you should send the following request:
/api/v1/Context/?ids=1424
<Context Acid="5183C75C9C20036C59F25256D20BCE95">
<Edition>Pro</Edition>
<LoggedUser Id="316">
<FirstName>Administrator</FirstName>
<LastName>Administrator</LastName>
<Email>admin@nonexistingemail.com</Email>
<IsActive>true</IsActive>
<IsAdministrator>true</IsAdministrator>
</LoggedUser>
<Culture Name="en-US" TimePattern="g:i A" ShortDateFormat="M/d/yyyy" LongDateFormat="dddd, MMMM dd, yyyy" DecimalSeparator="." />
<SelectedProjects>
<ProjectInfo Id="375" Name="Targetprocess">
<Process Id="1" Name="All Practices" />
<Program nil="true" />
</ProjectInfo>
</SelectedProjects>
<Processes>
<ProcessInfo Id="1" Name="All Practices">
<Terms>
<Term Name="Features">
<Value>Epics</Value>
</Term>
<Term Name="Feature Big Icon Text">
<Value>Epic</Value>
</Term>
<Term Name="Feature Small Icon Text">
<Value>E</Value>
</Term>
</Terms>
<Practices>
<Practice Name="Planning">
<EffortPoints>Hour</EffortPoints>
<IsStoryEffortEqualsSumTasksEffort>false</IsStoryEffortEqualsSumTasksEffort>
</Practice>
<Practice Name="Time Tracking">
<IsCloseAssignableIfZeroTimeRemaining>false</IsCloseAssignableIfZeroTimeRemaining>
<IsTimeDescriptionFieldVisible>true</IsTimeDescriptionFieldVisible>
<IsTimeDescriptionRequired>true</IsTimeDescriptionRequired>
<IsRequiredShowRoleDropDown>false</IsRequiredShowRoleDropDown>
</Practice>
<Practice Name="Bug Tracking" />
<Practice Name="Requirements" />
<Practice Name="Test Cases" />
<Practice Name="Source Control" />
<Practice Name="Help Desk" />
<Practice Name="Iterations" />
</Practices>
<CustomFields>
<CustomFieldInfo Name="Custom description">
<EntityKind>UserStory</EntityKind>
<Type>Text</Type>
<Required>false</Required>
<Listed>false</Listed>
</CustomFieldInfo>
</CustomFields>
</ProcessInfo>
</Processes>
</Context>
| Context |
|---|
| Default context (Context without parameters) <codeph>/api/v1/Context/</codeph> |
| Context for specific Entities <codeph>/api/v1/Context/?ids=1,88</codeph> |
| Context for specific Projects <codeph>/api/v1/Context/?projectIds=123,456&teamIds=*</codeph> |
| Context for specific Projects and Teams <codeph>/api/v1/Context/?projectIds=123,456&teamIds=23,45</codeph> |
| Context for ACID <codeph>/api/v1/Context/?acid=E1D0F26614C81DD3A6B077E0B4C05138</codeph> |
Warning: Context does not support partial get.