Context

Context is a special type of resource. It contains information about logged user, culture, selected projects and processes.

You need Context in the following cases:

• Retrieve list of entities for specific projects (via Acid).
• Retrieve information about culture (date, time and number format) to correctly show data.
• Retrieve information about processes for all selected projects (Terms, Practices and Custom Fields).

Here is an example of Context:

<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	Example	Response
Default context (Context without parameters)	http://localhost/targetprocess/api/v1/Context/	Returns context for all the projects available to authenticated user.
Context for specific entities	http://localhost/targetprocess/api/v1/Context/?ids=1,88	Returns context for projects that contain entities with ids 1 and 88. Context contains projects that you have access to.
Context for Acid	http://localhost/targetprocess/api/v1/Context/?acid=E1D0F26614C81DD3A6B077E0B4C05138	Returns context for specific acid.

Acid is a unique key that identifies context. You can use Acid to retrieve a collection of entities from a particular context.

REST API Chapters

1. Getting Started
2. Concepts
1. Resources and collections
2. Context
3. Authentication
4. Response: Formats, Paging, Filters, Partial Get
5. Create, update and delete operations
6. Restful Storage
3. FAQ
4. Reference

Context