Class OrgResponse.Builder
- Enclosing class:
OrgResponse
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) build()Whether this call created a new organization.Timestamp when the organization was created, as an ISO-8601 UTC timestamp.externalId(String externalId) externalId(Optional<String> externalId) Your own identifier for this organization, as supplied when it was created.from(OrgResponse other) The Vectros-assigned ID (UUID) for this organization.Human-readable name of the organization.Free-form key-value attributes stored with the organization.ID of the record schema that governs payload validation and lookup indexing for this organization, or null if the organization is not bound to a schema.schemaVersion(Integer schemaVersion) schemaVersion(Optional<Integer> schemaVersion) The version of the governing schema in effect when this organization was last written.Lifecycle status of the organization:ACTIVE(usable normally) orSUSPENDED(retained but blocked from new operations).
-
Method Details
-
from
-
created
Whether this call created a new organization. True when a new organization was created; false when an organization with the same
externalIdalready existed and was returned unchanged (idempotent create) or updated (when?upsert=true). Present only on the create response (POST /v1/orgs); absent on reads. The HTTP status mirrors it — 201 when created, 200 when an existing organization was returned. -
created
-
id
The Vectros-assigned ID (UUID) for this organization. Use it wherever you reference the organization elsewhere — for example as the owner of a record or as a filter value when listing records.
-
id
-
externalId
Your own identifier for this organization, as supplied when it was created.
-
externalId
-
name
Human-readable name of the organization.
-
name
-
status
Lifecycle status of the organization:
ACTIVE(usable normally) orSUSPENDED(retained but blocked from new operations). -
status
-
payload
Free-form key-value attributes stored with the organization.
-
payload
-
schemaId
ID of the record schema that governs payload validation and lookup indexing for this organization, or null if the organization is not bound to a schema.
-
schemaId
-
schemaVersion
The version of the governing schema in effect when this organization was last written. The organization keeps the schema version it was stamped with even after the schema is later edited. Null when the organization is not bound to a schema.
-
schemaVersion
-
createdAt
Timestamp when the organization was created, as an ISO-8601 UTC timestamp.
-
createdAt
-
build
-
additionalProperty
-
additionalProperties
-