Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

C1 Request Schema API

The Request Schema API from C1 — 2 operation(s) for request schema.

C1 Request Schema API is one of 47 APIs that C1 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Request Schema. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 50 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0-alpha.

Requests are made against a single base URL, https://{tenantDomain}.conductor.one.

4 operations 2 paths 50 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0-alpha
Base URL
https://example.conductor.one
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

C1 Request Schema API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth) using the clientCredentials flow. By default, every request must be authenticated.

  • oauth — This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, re…

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Request Schema 4
POST
/api/v1/request_schemas
Create
c1.api.request_schema.v1.RequestSchemaService.Create body → 200
DELETE
/api/v1/request_schemas/{request_schema_id}
Delete
c1.api.request_schema.v1.RequestSchemaService.Delete 1 param body → 200
GET
/api/v1/request_schemas/{request_schema_id}
Get
c1.api.request_schema.v1.RequestSchemaService.Get 1 param → 200
POST
/api/v1/request_schemas/{request_schema_id}
Update
c1.api.request_schema.v1.RequestSchemaService.Update 1 param body → 200

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are validate.StringRules (26 properties), validate.FieldRules (22 properties), validate.BytesRules (14 properties), validate.TimestampRules (9 properties). Each schema is shown below with its type and property counts.

validate.EnumRules
object
EnumRules describe the constraints applied to enum values
4 properties
validate.StringRules
object
StringRules describe the constraints applied to string values This message contains a oneof named wellknown. Only a single field of the following list may be s…
26 properties
validate.TimestampRules
object
TimestampRules describe the constraints applied exclusively to the google.protobuf.Timestamp well-known type
9 properties
c1.api.form.v1.TextField
object
The TextField message.
1 property
c1.api.form.v1.PasswordField
object
The PasswordField message.
c1.api.request_schema.v1.RequestSchemaServiceCreateResponse
object
The RequestSchemaServiceCreateResponse message.
1 property
c1.api.request_schema.v1.RequestSchemaServiceDeleteRequestInput
object
The RequestSchemaServiceDeleteRequest message.
c1.api.request_schema.v1.RequestSchemaServiceCreateRequest
object
The RequestSchemaServiceCreateRequest message.
3 properties
c1.api.form.v1.FileInputField
object
The FileInputField message.
validate.RepeatedRules
object
RepeatedRules describe the constraints applied to repeated values
5 properties
validate.SFixed64Rules
object
SFixed64Rules describes the constraints applied to sfixed64 values
8 properties
validate.AnyRules
object
AnyRules describe constraints applied exclusively to the google.protobuf.Any well-known type
3 properties
c1.api.request_schema.v1.RequestSchemaServiceUpdateResponse
object
The RequestSchemaServiceUpdateResponse message.
1 property
validate.MapRules
object
MapRules describe the constraints applied to map values
6 properties
validate.Fixed64Rules
object
Fixed64Rules describes the constraints applied to fixed64 values
8 properties
validate.DurationRules
object
DurationRules describe the constraints applied exclusively to the google.protobuf.Duration well-known type
8 properties
c1.api.form.v1.BoolField
object
The BoolField message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - checkboxField This message c…
3 properties
validate.Fixed32Rules
object
Fixed32Rules describes the constraints applied to fixed32 values
8 properties
c1.api.form.v1.SelectField
object
The SelectField message.
1 property
validate.MessageRules
object
MessageRules describe the constraints applied to embedded message values. For message-type fields, validation is performed recursively.
2 properties
c1.api.form.v1.FieldRelationship
object
FieldRelationships can be used during form validation, or they can represent information that is necessary to when it comes to visually rendering the form This…
4 properties
c1.api.form.v1.RequiredTogether
object
The RequiredTogether message.
c1.api.form.v1.CheckboxField
object
The CheckboxField message.
c1.api.request_schema.v1.RequestSchemaServiceGetResponse
object
The RequestSchemaServiceGetResponse message.
1 property
c1.api.form.v1.AtLeastOne
object
The AtLeastOne message.
validate.FieldRules
object
FieldRules encapsulates the rules for each type of field. Depending on the field, the correct set should be used to ensure proper validations. This message con…
22 properties
c1.api.request_schema.v1.RequestSchemaServiceUpdateRequestInput
object
The RequestSchemaServiceUpdateRequest message.
2 properties
c1.api.form.v1.Int64Field
object
The Int64Field message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - numberField This message co…
4 properties
c1.api.form.v1.StringSliceField
object
The StringSliceField message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - chipsField This messa…
4 properties
validate.Int64Rules
object
Int64Rules describes the constraints applied to int64 values
8 properties
c1.api.request_schema.v1.RequestSchema
object
The RequestSchema message.
5 properties
validate.SInt32Rules
object
SInt32Rules describes the constraints applied to sint32 values
8 properties
validate.BoolRules
object
BoolRules describes the constraints applied to bool values
1 property
c1.api.form.v1.Field
object
A field is a single input meant to collect a piece of data from a user This message contains a oneof named type. Only a single field of the following list may…
8 properties
validate.Int32Rules
object
Int32Rules describes the constraints applied to int32 values
8 properties
c1.api.request_schema.v1.RequestSchemaServiceDeleteResponse
object
The RequestSchemaServiceDeleteResponse message.
c1.api.form.v1.Form
object
A form is a collection of fields to be filled out by a user
5 properties
validate.SInt64Rules
object
SInt64Rules describes the constraints applied to sint64 values
8 properties
c1.api.form.v1.FileField
object
The FileField message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - fileInputField This message…
3 properties
c1.api.form.v1.StringField
object
The StringField message. This message contains a oneof named view. Only a single field of the following list may be set at a time: - textField - passwordField…
6 properties
validate.BytesRules
object
BytesRules describe the constraints applied to bytes values This message contains a oneof named wellknown. Only a single field of the following list may be set…
14 properties
validate.SFixed32Rules
object
SFixed32Rules describes the constraints applied to sfixed32 values
8 properties
c1.api.form.v1.SelectOption
object
The SelectOption message.
2 properties
validate.DoubleRules
object
DoubleRules describes the constraints applied to double values
8 properties
validate.UInt64Rules
object
UInt64Rules describes the constraints applied to uint64 values
8 properties
validate.UInt32Rules
object
UInt32Rules describes the constraints applied to uint32 values
8 properties
c1.api.form.v1.ChipsField
object
The ChipsField message.
validate.FloatRules
object
FloatRules describes the constraints applied to float values
8 properties
c1.api.form.v1.NumberField
object
The NumberField message.
3 properties
c1.api.form.v1.MutuallyExclusive
object
The MutuallyExclusive message.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

c1-request-schema-api-openapi.yml Raw ↑

Other APIs C1 publishes across the network.

Baton Connector Framework
C1 Access Conflict API
C1 App API
C1 App Entitlement API
C1 App Entitlement Automation API
C1 App Entitlement Automation Exclusion API
C1 App Entitlement Monitor Binding API
C1 App Entitlement Owner API
C1 App Entitlement Proxy Binding API
C1 App Entitlement User Binding API
C1 App Entitlement User Binding Feed API
C1 App Entitlement User Binding History API