Context

Suggest Edits

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>[email protected]</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	Response
Default context (Context without parameters) `/api/v1/Context/`	Returns context for all the Projectaavailable to authenticated user.
Context for specific Entities `/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 specific Projects `/api/v1/Context/?projectIds=123,456&teamIds=*`	Returns context for Projects 123 and 456. Context contains Projects that you have access to.
Context for specific Projects and Teams `/api/v1/Context/?projectIds=123,456&teamIds=23,45`	Returns context for Projects 123 and 456 and Teams 23 and 45. Context contains Projects and Teams that you have access to.
Context for ACID `/api/v1/Context/?acid=E1D0F26614C81DD3A6B077E0B4C05138`	Returns context for specific ACID.

🚧
Context does not support partial get.

Updated over 6 years ago