Simple output set

SimpleOutputSet

Returned by: JinkoClient.create_simple_output_set, JinkoClient.create_simple_output_set_from_json, JinkoClient.get_simple_output_set, JinkoClient.iter_simple_output_sets, JinkoClient.list_simple_output_sets, Model.create_simple_output_set, SimpleOutputSet.add_measures, SimpleOutputSet.remove_measures, SimpleOutputSet.replace_all_measures, SimpleOutputSet.update_measure, Trial.simple_output_set

Also has every member of ProjectItem.

Member	Kind	Description
`content`	method	Return the full structured definition of this simple output set.
`measures`	property	Return the measures currently defined in this simple output set.
`labels`	property	Return labels for this output set's current snapshot.
`replace_all_measures`	method	Replace the full measures list of this simple output set.
`add_measures`	method	Append one or more measures to this simple output set.
`remove_measures`	method	Remove all measures matching the provided filters.
`update_measure`	method	Update one measure selected by name or immutable id.

content

content(
    *, revision: int | None = None
) -> openapi_types.MeasureDesignWithMetadata

Return the full structured definition of this simple output set.

The returned object includes:

the source model reference used by the output set
the full list of measures
any available metadata summary for the current snapshot or revision

Each measure includes its output id and may also include a custom name, origin, immutable id, and a function describing how the scalar is derived from the timeseries.

measures

Type: list[openapi_types.Measure]

Return the measures currently defined in this simple output set.

Each returned entry is a structured measure object with:

timeseriesId for the measured model output
optional name
optional origin
optional immutableId
optional function for point-in-time or across-time calculations

Use content when you also need the source model reference or metadata for the full output set.

labels

Type: Any

Return labels for this output set's current snapshot.

Labels are currently exposed by the API only for simple output sets. When other project-item resources gain equivalent endpoints, each domain type should expose this same property through its own service method.

replace_all_measures

replace_all_measures(
    measures: list[str | dict[str, Any]], *, version: str | dict | None = None
) -> SimpleOutputSet

Replace the full measures list of this simple output set.

This discards all existing measures and writes exactly the entries you provide. Each entry may be either a shorthand output id string or a full measure dictionary using the same accepted shape as Model.create_simple_output_set.

add_measures

add_measures(
    measures: list[str | dict[str, Any]], *, version: str | dict | None = None
) -> SimpleOutputSet

Append one or more measures to this simple output set.

remove_measures

remove_measures(
    *,
    names: list[str] | None = None,
    immutable_ids: list[str] | None = None,
    timeseries_ids: list[str] | None = None,
    version: str | dict | None = None
) -> SimpleOutputSet

Remove all measures matching the provided filters.

A measure is removed when it matches any provided selector set. At least one selector family must be provided.

update_measure

update_measure(
    selector: str,
    *,
    by: Literal["name", "immutable_id"] = "name",
    new_timeseries_id: str | None | UnsetType = UNSET,
    new_name: str | None | UnsetType = UNSET,
    new_origin: str | None | UnsetType = UNSET,
    new_function: dict[str, Any] | None | UnsetType = UNSET,
    new_immutable_id: str | None | UnsetType = UNSET,
    version: str | dict | None = None
) -> SimpleOutputSet

Update one measure selected by name or immutable id.

Omitted new_* parameters leave that field unchanged. Passing None explicitly removes an optional field such as name, function, or immutableId.