# 从 CircleCI 实体中读取内容
<a name="circleci-reading-from-entities"></a>

**先决条件**

要从中读取内容的 CircleCI 对象。您将需要对象名称。

**源支持的实体**：


| 实体 | 可以筛选 | 支持限制 | 支持排序依据 | 支持 Select \* | 支持分区 | 
| --- | --- | --- | --- | --- | --- | 
| 上下文 | 是 | 否 | 否 | 是 | 否 | 
| Organization Summary Metric | 是 | 否 | 否 | 是 | 否 | 
| 管道 | 否 | 否 | 否 | 是 | 否 | 
| 管道工作流 | 是 | 否 | 否 | 是 | 否 | 
| Project Branch | 是 | 否 | 否 | 是 | 否 | 
| Project Flaky Test | 否 | 否 | 否 | 是 | 否 | 
| Project Summary Metric | 是 | 否 | 否 | 是 | 否 | 
| 计划 | 否 | 否 | 否 | 是 | 否 | 
| Workflow Job Timeseries | 是 | 否 | 否 | 是 | 否 | 
| Workflow Metric And Trend | 是 | 否 | 否 | 是 | 否 | 
| Workflow Recent Run | 是 | 否 | 否 | 是 | 否 | 
| Workflow Summary Metric | 是 | 否 | 否 | 是 | 否 | 
| Workflow Test Metric | 是 | 否 | 否 | 是 | 否 | 

**示例：**

```
circleci_read = glueContext.create_dynamic_frame.from_options(
    connection_type="circleci",
    connection_options={
        "connectionName": "connectionName",
        "ENTITY_NAME": "context/e7ea2945-dccb-4205-b673-8391fe1b3a4c",
        "API_VERSION": "v2"
    }
```

## CircleCI 实体和字段详细信息
<a name="circleci-reading-from-entities-field-details"></a>

有关实体和字段详细信息的更多信息，请参阅：
+ [Contexts](https://circleci.com/docs/api/v2/#operation/listContexts)
+ [Project Summary Metrics](https://circleci.com/docs/api/v2/#operation/getProjectWorkflowsPageData)
+ [Workflow Job Timeseries](https://circleci.com/docs/api/v2/#operation/getJobTimeseries)
+ [Organization Summary Metrics](https://circleci.com/docs/api/v2/#operation/getOrgSummaryData)
+ [Project Branches](https://circleci.com/docs/api/v2/#operation/getAllInsightsBranches)
+ [Project Flaky Tests](https://circleci.com/docs/api/v2/#operation/getFlakyTests)
+ [Workflow Recent Runs](https://circleci.com/docs/api/v2/#operation/getProjectWorkflowRuns)
+ [Workflow Summary Metrics](https://circleci.com/docs/api/v2/#operation/getProjectWorkflowMetrics)
+ [Workflow Metrics and Trends](https://circleci.com/docs/api/v2/#operation/getWorkflowSummary)
+ [Workflow Test Metrics](https://circleci.com/docs/api/v2/#operation/getProjectWorkflowTestMetrics)
+ [Pipelines](https://circleci.com/docs/api/v2/#operation/listPipelinesForProject)
+ [Pipeline Workflows](https://circleci.com/docs/api/v2/#operation/listWorkflowsByPipelineId)
+ [Schedules](https://circleci.com/docs/api/v2/#operation/listSchedulesForProject)

具有静态元数据的实体：



- **上下文**
  - **字段:** Created At / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 名称 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Owner Type / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO

- **Organization Summary Metric**
  - **字段:** All Projects / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** Org Data / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** Org Project Data / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** Project Names / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** Reporting Window / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO

- **管道**
  - **字段:** 分支 / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** Created At / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 错误 / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 数字 / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** Project Slug / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 状态 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 触发器 / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** Trigger Parameters / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** Updated At / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** VCS / **数据类型:** 结构体 / **支持的运算符:** 

- **管道工作流**
  - **字段:** Canceled By / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Created At / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Errorer By / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 名称 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 管道 ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Pipeline Number / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** Project Slug / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Started By / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 状态 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Stopped At / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Tag / **数据类型:** 字符串 / **支持的运算符:** 

- **Project Branch**
  - **字段:** Branches / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** Org ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Project ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 工作流名称 / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO

- **Project Flaky Test**
  - **字段:** Classname / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 文件 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Job Name / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Job Number / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** Pipeline Number / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** 来源 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Test Name / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Time Wasted / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** Times Flaked / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** Workflow Created At / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 工作流 ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 工作流名称 / **数据类型:** 字符串 / **支持的运算符:** 

- **Project Summary Metric**
  - **字段:** All Branches / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** All Workflows / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** Branches / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** 组织 ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Project Data / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** Project ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Project Workflow Branch Data / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** Project Workflow Data / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** Reporting Window / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** Workflow Names / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO

- **计划**
  - **字段:** 角色 / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** Created At / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 描述 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 名称 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 参数 / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** Project Slug / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Timetable / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** Updated At / **数据类型:** 字符串 / **支持的运算符:** 

- **Workflow Job Timeseries**
  - **字段:** 分支 / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** 粒度 / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** Max Ended At / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Metrics / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** Min Started At / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** 名称 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Start End Date / **数据类型:** 日期时间 / **支持的运算符:** EQUAL\_TO、BETWEEN
  - **字段:** Timestamp / **数据类型:** 字符串 / **支持的运算符:** 

- **Workflow Metric and Trend**
  - **字段:** All Branches / **数据类型:** 布尔值 / **支持的运算符:** EQUAL\_TO
  - **字段:** Branches / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** Metrics / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** Trends / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** Workflow Names / **数据类型:** 列表 / **支持的运算符:** 

- **Workflow Recent Run**
  - **字段:** All Brances / **数据类型:** 布尔值 / **支持的运算符:** EQUAL\_TO
  - **字段:** 分支 / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** Created At / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Credits Used / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** 持续时间 / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Is Approval / **数据类型:** 布尔值 / **支持的运算符:** 
  - **字段:** Start End Date / **数据类型:** 日期时间 / **支持的运算符:** EQUAL\_TO、BETWEEN
  - **字段:** 状态 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Stopped At / **数据类型:** 字符串 / **支持的运算符:** 

- **Workflow Summary Metric**
  - **字段:** All Branches / **数据类型:** 布尔值 / **支持的运算符:** EQUAL\_TO
  - **字段:** 分支 / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** Metrics / **数据类型:** 结构体 / **支持的运算符:** 
  - **字段:** 名称 / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Project ID / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Reporting Window / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** Window End / **数据类型:** 字符串 / **支持的运算符:** 
  - **字段:** Window Start / **数据类型:** 字符串 / **支持的运算符:** 

- **Workflow Test Metric**
  - **字段:** Average Test Count / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** 分支 / **数据类型:** 字符串 / **支持的运算符:** EQUAL\_TO
  - **字段:** Most Failed Tests / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** Most Failed Tests Extra / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** Slowest Tests / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** Slowest Tests Extra / **数据类型:** 整数 / **支持的运算符:** 
  - **字段:** Test Runs / **数据类型:** 列表 / **支持的运算符:** 
  - **字段:** Total Test Runs / **数据类型:** 整数 / **支持的运算符:** 



**注意**  
在连接器的响应中，结构和列表数据类型将转换为字符串数据类型。

**对查询进行分区**

CircleCI 不支持基于字段的分区或基于记录的分区。