liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
1,767 lines • 60.1 kB
TypeScript
export type ObjectAction = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
conditionExpression?: string;
readonly dateCreated?: string;
readonly dateModified?: string;
description?: string;
errorMessage?: {
[key: string]: string;
};
externalReferenceCode?: string;
readonly id?: number;
label?: {
[key: string]: string;
};
name?: string;
objectActionExecutorKey?: string;
objectActionTriggerKey?: string;
parameters?: {
[key: string]: {
[key: string]: unknown;
};
};
status?: Status;
system?: boolean;
readonly 'x-class-name'?: string;
};
export type Status = {
code?: number;
label?: string;
label_i18n?: string;
readonly 'x-class-name'?: string;
};
export type Facet = {
facetCriteria?: string;
facetValues?: Array<FacetValue>;
};
export type FacetValue = {
numberOfOccurrences?: number;
term?: string;
};
export type PageObjectAction = {
items?: Array<ObjectAction>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Creator = {
/**
* The author's additional name (e.g., middle name).
*/
readonly additionalName?: string;
/**
* The type of the content.
*/
readonly contentType?: string;
/**
* The external reference code of the author.
*/
readonly externalReferenceCode?: string;
/**
* The author's surname.
*/
readonly familyName?: string;
/**
* The author's first name.
*/
readonly givenName?: string;
/**
* The author's ID.
*/
readonly id?: number;
/**
* A relative URL to the author's profile image.
*/
readonly image?: string;
/**
* The author's full name.
*/
readonly name?: string;
/**
* A relative URL to the author's user profile. Optional field, can be embedded with nestedFields.
*/
readonly profileURL?: string;
/**
* A list of userGroups information.
*/
userGroupBriefs?: Array<UserGroupBrief>;
readonly 'x-class-name'?: string;
};
export type ObjectDefinition = {
accountEntryRestricted?: boolean;
accountEntryRestrictedObjectFieldName?: string;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
className?: string;
creator?: Creator;
readonly dateCreated?: string;
readonly dateModified?: string;
defaultLanguageId?: string;
enableCategorization?: boolean;
enableComments?: boolean;
enableFriendlyURLCustomization?: boolean;
enableIndexSearch?: boolean;
enableLocalization?: boolean;
enableObjectEntryDraft?: boolean;
enableObjectEntryHistory?: boolean;
enableObjectEntrySchedule?: boolean;
enableObjectEntrySubscription?: boolean;
enableObjectEntryVersioning?: boolean;
externalReferenceCode?: string;
friendlyURLSeparator?: string;
readonly id?: number;
label?: {
[key: string]: string;
};
modifiable?: boolean;
name?: string;
objectActions?: Array<ObjectAction>;
objectDefinitionSettings?: Array<ObjectDefinitionSetting>;
objectFields?: Array<ObjectField>;
objectFolderExternalReferenceCode?: string;
objectLayouts?: Array<ObjectLayout>;
objectRelationships?: Array<ObjectRelationship>;
objectValidationRules?: Array<ObjectValidationRule>;
objectViews?: Array<ObjectView>;
panelAppOrder?: string;
panelCategoryKey?: string;
readonly parameterRequired?: boolean;
pluralLabel?: {
[key: string]: string;
};
portlet?: boolean;
readonly restContextPath?: string;
readonly rootObjectDefinitionExternalReferenceCode?: string;
scope?: string;
status?: Status;
storageType?: string;
system?: boolean;
titleObjectFieldName?: string;
readonly 'x-class-name'?: string;
};
export type ObjectDefinitionSetting = {
readonly id?: number;
name?: string;
objectDefinitionId?: number;
value?: {
[key: string]: unknown;
};
readonly 'x-class-name'?: string;
};
export type ObjectField = {
DBType?: 'BigDecimal' | 'Boolean' | 'Clob' | 'Date' | 'DateTime' | 'Double' | 'Integer' | 'Long' | 'String';
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
/**
* @deprecated
*/
defaultValue?: string;
externalReferenceCode?: string;
readonly id?: number;
indexed?: boolean;
indexedAsKeyword?: boolean;
indexedLanguageId?: string;
label?: {
[key: string]: string;
};
listTypeDefinitionExternalReferenceCode?: string;
listTypeDefinitionId?: number;
localized?: boolean;
name?: string;
objectDefinitionExternalReferenceCode1?: string;
objectFieldSettings?: Array<ObjectFieldSetting>;
objectRelationshipExternalReferenceCode?: string;
readOnlyConditionExpression?: string;
required?: boolean;
state?: boolean;
system?: boolean;
readonly unique?: boolean;
readonly 'x-class-name'?: string;
businessType?: 'Aggregation' | 'Attachment' | 'AutoIncrement' | 'Boolean' | 'Date' | 'DateTime' | 'Decimal' | 'Encrypted' | 'Formula' | 'Integer' | 'LongInteger' | 'LongText' | 'MultiselectPicklist' | 'Picklist' | 'PrecisionDecimal' | 'Relationship' | 'RichText' | 'Text';
readOnly?: 'conditional' | 'false' | 'true';
relationshipType?: 'oneToMany' | 'oneToOne';
/**
* @deprecated
*/
type?: 'BigDecimal' | 'Boolean' | 'Clob' | 'Date' | 'DateTime' | 'Double' | 'Integer' | 'Long' | 'String';
};
export type ObjectFieldSetting = {
readonly id?: number;
name?: string;
objectFieldId?: number;
value?: {
[key: string]: unknown;
};
readonly 'x-class-name'?: string;
};
export type ObjectLayout = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly dateCreated?: string;
readonly dateModified?: string;
defaultObjectLayout?: boolean;
readonly id?: number;
name?: {
[key: string]: string;
};
objectDefinitionExternalReferenceCode?: string;
objectDefinitionId?: number;
objectLayoutTabs?: Array<ObjectLayoutTab>;
readonly 'x-class-name'?: string;
};
export type ObjectLayoutBox = {
collapsable?: boolean;
readonly id?: number;
name?: {
[key: string]: string;
};
objectLayoutRows?: Array<ObjectLayoutRow>;
priority?: number;
readonly 'x-class-name'?: string;
type?: 'categorization' | 'regular';
};
export type ObjectLayoutColumn = {
readonly id?: number;
objectFieldName?: string;
priority?: number;
size?: number;
readonly 'x-class-name'?: string;
};
export type ObjectLayoutRow = {
readonly id?: number;
objectLayoutColumns?: Array<ObjectLayoutColumn>;
priority?: number;
readonly 'x-class-name'?: string;
};
export type ObjectLayoutTab = {
readonly id?: number;
name?: {
[key: string]: string;
};
objectLayoutBoxes?: Array<ObjectLayoutBox>;
objectRelationshipExternalReferenceCode?: string;
objectRelationshipId?: number;
priority?: number;
readonly 'x-class-name'?: string;
};
export type ObjectRelationship = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
edge?: boolean;
externalReferenceCode?: string;
readonly id?: number;
label?: {
[key: string]: string;
};
name?: string;
objectDefinitionExternalReferenceCode1?: string;
objectDefinitionExternalReferenceCode2?: string;
objectDefinitionId1?: number;
objectDefinitionId2?: number;
objectDefinitionModifiable2?: boolean;
objectDefinitionName2?: string;
objectDefinitionScope2?: string;
objectDefinitionSystem2?: boolean;
objectField?: ObjectField;
parameterObjectFieldId?: number;
parameterObjectFieldName?: string;
readonly reverse?: boolean;
system?: boolean;
readonly 'x-class-name'?: string;
deletionType?: 'cascade' | 'disassociate' | 'prevent';
type?: 'oneToMany' | 'oneToOne' | 'manyToMany';
};
export type ObjectValidationRule = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
readonly dateCreated?: string;
readonly dateModified?: string;
engine?: string;
readonly engineLabel?: string;
errorLabel?: {
[key: string]: string;
};
externalReferenceCode?: string;
readonly id?: number;
name?: {
[key: string]: string;
};
objectDefinitionExternalReferenceCode?: string;
objectDefinitionId?: number;
objectValidationRuleSettings?: Array<ObjectValidationRuleSetting>;
script?: string;
system?: boolean;
readonly 'x-class-name'?: string;
outputType?: 'fullValidation' | 'partialValidation';
};
export type ObjectValidationRuleSetting = {
name?: string;
value?: {
[key: string]: unknown;
};
readonly 'x-class-name'?: string;
};
export type ObjectView = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly dateCreated?: string;
readonly dateModified?: string;
defaultObjectView?: boolean;
readonly id?: number;
name?: {
[key: string]: string;
};
objectDefinitionExternalReferenceCode?: string;
objectDefinitionId?: number;
objectViewColumns?: Array<ObjectViewColumn>;
objectViewFilterColumns?: Array<ObjectViewFilterColumn>;
objectViewSortColumns?: Array<ObjectViewSortColumn>;
readonly 'x-class-name'?: string;
};
export type ObjectViewColumn = {
readonly id?: number;
label?: {
[key: string]: string;
};
objectFieldName?: string;
priority?: number;
readonly 'x-class-name'?: string;
};
export type ObjectViewFilterColumn = {
readonly id?: number;
json?: string;
objectFieldName?: string;
readonly valueSummary?: string;
readonly 'x-class-name'?: string;
filterType?: 'excludes' | 'includes';
};
export type ObjectViewSortColumn = {
readonly id?: number;
objectFieldName?: string;
priority?: number;
readonly 'x-class-name'?: string;
sortOrder?: 'asc' | 'desc';
};
/**
* A list of userGroups information.
*/
export type UserGroupBrief = {
/**
* The ID of the user group.
*/
readonly id?: number;
/**
* The name of the user group.
*/
readonly name?: string;
readonly 'x-class-name'?: string;
};
export type PageObjectDefinition = {
items?: Array<ObjectDefinition>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageObjectField = {
items?: Array<ObjectField>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type ObjectFolder = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly dateCreated?: string;
readonly dateModified?: string;
externalReferenceCode?: string;
readonly id?: number;
label?: {
[key: string]: string;
};
name?: string;
objectFolderItems?: Array<ObjectFolderItem>;
readonly 'x-class-name'?: string;
};
export type ObjectFolderItem = {
linkedObjectDefinition?: boolean;
objectDefinition?: ObjectDefinition;
objectDefinitionExternalReferenceCode?: string;
positionX?: number;
positionY?: number;
readonly 'x-class-name'?: string;
};
export type PageObjectFolder = {
items?: Array<ObjectFolder>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageObjectLayout = {
items?: Array<ObjectLayout>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageObjectRelationship = {
items?: Array<ObjectRelationship>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageObjectValidationRule = {
items?: Array<ObjectValidationRule>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageObjectView = {
items?: Array<ObjectView>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DeleteObjectActionData = {
body?: never;
path: {
objectActionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-actions/{objectActionId}';
};
export type DeleteObjectActionResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectActionData = {
body?: never;
path: {
objectActionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-actions/{objectActionId}';
};
export type GetObjectActionResponses = {
/**
* default response
*/
default: ObjectAction;
};
export type GetObjectActionResponse = GetObjectActionResponses[keyof GetObjectActionResponses];
export type PatchObjectActionData = {
body?: ObjectAction;
path: {
objectActionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-actions/{objectActionId}';
};
export type PatchObjectActionResponses = {
/**
* default response
*/
default: ObjectAction;
};
export type PatchObjectActionResponse = PatchObjectActionResponses[keyof PatchObjectActionResponses];
export type PutObjectActionData = {
body?: ObjectAction;
path: {
objectActionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-actions/{objectActionId}';
};
export type PutObjectActionResponses = {
/**
* default response
*/
default: ObjectAction;
};
export type PutObjectActionResponse = PutObjectActionResponses[keyof PutObjectActionResponses];
export type DeleteObjectActionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-actions/batch';
};
export type DeleteObjectActionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutObjectActionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-actions/batch';
};
export type PutObjectActionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectDefinitionByExternalReferenceCodeObjectActionsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/object-admin/v1.0/object-definitions/by-external-reference-code/{externalReferenceCode}/object-actions';
};
export type GetObjectDefinitionByExternalReferenceCodeObjectActionsPageResponses = {
/**
* default response
*/
default: PageObjectAction;
};
export type GetObjectDefinitionByExternalReferenceCodeObjectActionsPageResponse = GetObjectDefinitionByExternalReferenceCodeObjectActionsPageResponses[keyof GetObjectDefinitionByExternalReferenceCodeObjectActionsPageResponses];
export type PostObjectDefinitionByExternalReferenceCodeObjectActionData = {
body?: ObjectAction;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/by-external-reference-code/{externalReferenceCode}/object-actions';
};
export type PostObjectDefinitionByExternalReferenceCodeObjectActionResponses = {
/**
* default response
*/
default: ObjectAction;
};
export type PostObjectDefinitionByExternalReferenceCodeObjectActionResponse = PostObjectDefinitionByExternalReferenceCodeObjectActionResponses[keyof PostObjectDefinitionByExternalReferenceCodeObjectActionResponses];
export type GetObjectDefinitionObjectActionsPageData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: {
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-actions';
};
export type GetObjectDefinitionObjectActionsPageResponses = {
/**
* default response
*/
default: PageObjectAction;
};
export type GetObjectDefinitionObjectActionsPageResponse = GetObjectDefinitionObjectActionsPageResponses[keyof GetObjectDefinitionObjectActionsPageResponses];
export type PostObjectDefinitionObjectActionData = {
body?: ObjectAction;
path: {
objectDefinitionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-actions';
};
export type PostObjectDefinitionObjectActionResponses = {
/**
* default response
*/
default: ObjectAction;
};
export type PostObjectDefinitionObjectActionResponse = PostObjectDefinitionObjectActionResponses[keyof PostObjectDefinitionObjectActionResponses];
export type PostObjectDefinitionObjectActionBatchData = {
body?: {
[key: string]: unknown;
};
path: {
objectDefinitionId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-actions/batch';
};
export type PostObjectDefinitionObjectActionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostObjectDefinitionObjectActionsPageExportBatchData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: {
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-actions/export-batch';
};
export type PostObjectDefinitionObjectActionsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteObjectDefinitionData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}';
};
export type DeleteObjectDefinitionResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectDefinitionData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}';
};
export type GetObjectDefinitionResponses = {
/**
* default response
*/
default: ObjectDefinition;
};
export type GetObjectDefinitionResponse = GetObjectDefinitionResponses[keyof GetObjectDefinitionResponses];
export type PatchObjectDefinitionData = {
body?: ObjectDefinition;
path: {
objectDefinitionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}';
};
export type PatchObjectDefinitionResponses = {
/**
* default response
*/
default: ObjectDefinition;
};
export type PatchObjectDefinitionResponse = PatchObjectDefinitionResponses[keyof PatchObjectDefinitionResponses];
export type PutObjectDefinitionData = {
body?: ObjectDefinition;
path: {
objectDefinitionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}';
};
export type PutObjectDefinitionResponses = {
/**
* default response
*/
default: ObjectDefinition;
};
export type PutObjectDefinitionResponse = PutObjectDefinitionResponses[keyof PutObjectDefinitionResponses];
export type DeleteObjectDefinitionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-definitions/batch';
};
export type DeleteObjectDefinitionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostObjectDefinitionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-definitions/batch';
};
export type PostObjectDefinitionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutObjectDefinitionBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-definitions/batch';
};
export type PutObjectDefinitionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectDefinitionByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/by-external-reference-code/{externalReferenceCode}';
};
export type GetObjectDefinitionByExternalReferenceCodeResponses = {
/**
* default response
*/
default: ObjectDefinition;
};
export type GetObjectDefinitionByExternalReferenceCodeResponse = GetObjectDefinitionByExternalReferenceCodeResponses[keyof GetObjectDefinitionByExternalReferenceCodeResponses];
export type PutObjectDefinitionByExternalReferenceCodeData = {
body?: ObjectDefinition;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/by-external-reference-code/{externalReferenceCode}';
};
export type PutObjectDefinitionByExternalReferenceCodeResponses = {
/**
* default response
*/
default: ObjectDefinition;
};
export type PutObjectDefinitionByExternalReferenceCodeResponse = PutObjectDefinitionByExternalReferenceCodeResponses[keyof PutObjectDefinitionByExternalReferenceCodeResponses];
export type GetObjectDefinitionsPageData = {
body?: never;
path?: never;
query?: {
aggregationTerms?: string;
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/object-admin/v1.0/object-definitions';
};
export type GetObjectDefinitionsPageResponses = {
/**
* default response
*/
default: PageObjectDefinition;
};
export type GetObjectDefinitionsPageResponse = GetObjectDefinitionsPageResponses[keyof GetObjectDefinitionsPageResponses];
export type PostObjectDefinitionData = {
body?: ObjectDefinition;
path?: never;
query?: never;
url: '/o/object-admin/v1.0/object-definitions';
};
export type PostObjectDefinitionResponses = {
/**
* default response
*/
default: ObjectDefinition;
};
export type PostObjectDefinitionResponse = PostObjectDefinitionResponses[keyof PostObjectDefinitionResponses];
export type PostObjectDefinitionPublishData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/publish';
};
export type PostObjectDefinitionPublishResponses = {
/**
* default response
*/
default: ObjectDefinition;
};
export type PostObjectDefinitionPublishResponse = PostObjectDefinitionPublishResponses[keyof PostObjectDefinitionPublishResponses];
export type PostObjectDefinitionsPageExportBatchData = {
body?: never;
path?: never;
query?: {
filter?: string;
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/object-admin/v1.0/object-definitions/export-batch';
};
export type PostObjectDefinitionsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteObjectFieldData = {
body?: never;
path: {
objectFieldId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-fields/{objectFieldId}';
};
export type DeleteObjectFieldResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectFieldData = {
body?: never;
path: {
objectFieldId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-fields/{objectFieldId}';
};
export type GetObjectFieldResponses = {
/**
* default response
*/
default: ObjectField;
};
export type GetObjectFieldResponse = GetObjectFieldResponses[keyof GetObjectFieldResponses];
export type PatchObjectFieldData = {
body?: ObjectField;
path: {
objectFieldId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-fields/{objectFieldId}';
};
export type PatchObjectFieldResponses = {
/**
* default response
*/
default: ObjectField;
};
export type PatchObjectFieldResponse = PatchObjectFieldResponses[keyof PatchObjectFieldResponses];
export type PutObjectFieldData = {
body?: ObjectField;
path: {
objectFieldId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-fields/{objectFieldId}';
};
export type PutObjectFieldResponses = {
/**
* default response
*/
default: ObjectField;
};
export type PutObjectFieldResponse = PutObjectFieldResponses[keyof PutObjectFieldResponses];
export type DeleteObjectFieldBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-fields/batch';
};
export type DeleteObjectFieldBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutObjectFieldBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-fields/batch';
};
export type PutObjectFieldBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectDefinitionByExternalReferenceCodeObjectFieldsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/object-admin/v1.0/object-definitions/by-external-reference-code/{externalReferenceCode}/object-fields';
};
export type GetObjectDefinitionByExternalReferenceCodeObjectFieldsPageResponses = {
/**
* default response
*/
default: PageObjectField;
};
export type GetObjectDefinitionByExternalReferenceCodeObjectFieldsPageResponse = GetObjectDefinitionByExternalReferenceCodeObjectFieldsPageResponses[keyof GetObjectDefinitionByExternalReferenceCodeObjectFieldsPageResponses];
export type PostObjectDefinitionByExternalReferenceCodeObjectFieldData = {
body?: ObjectField;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/by-external-reference-code/{externalReferenceCode}/object-fields';
};
export type PostObjectDefinitionByExternalReferenceCodeObjectFieldResponses = {
/**
* default response
*/
default: ObjectField;
};
export type PostObjectDefinitionByExternalReferenceCodeObjectFieldResponse = PostObjectDefinitionByExternalReferenceCodeObjectFieldResponses[keyof PostObjectDefinitionByExternalReferenceCodeObjectFieldResponses];
export type GetObjectDefinitionObjectFieldsPageData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-fields';
};
export type GetObjectDefinitionObjectFieldsPageResponses = {
/**
* default response
*/
default: PageObjectField;
};
export type GetObjectDefinitionObjectFieldsPageResponse = GetObjectDefinitionObjectFieldsPageResponses[keyof GetObjectDefinitionObjectFieldsPageResponses];
export type PostObjectDefinitionObjectFieldData = {
body?: ObjectField;
path: {
objectDefinitionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-fields';
};
export type PostObjectDefinitionObjectFieldResponses = {
/**
* default response
*/
default: ObjectField;
};
export type PostObjectDefinitionObjectFieldResponse = PostObjectDefinitionObjectFieldResponses[keyof PostObjectDefinitionObjectFieldResponses];
export type PostObjectDefinitionObjectFieldBatchData = {
body?: {
[key: string]: unknown;
};
path: {
objectDefinitionId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-fields/batch';
};
export type PostObjectDefinitionObjectFieldBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostObjectDefinitionObjectFieldsPageExportBatchData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: {
filter?: string;
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-fields/export-batch';
};
export type PostObjectDefinitionObjectFieldsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteObjectFolderData = {
body?: never;
path: {
objectFolderId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-folders/{objectFolderId}';
};
export type DeleteObjectFolderResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectFolderData = {
body?: never;
path: {
objectFolderId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-folders/{objectFolderId}';
};
export type GetObjectFolderResponses = {
/**
* default response
*/
default: ObjectFolder;
};
export type GetObjectFolderResponse = GetObjectFolderResponses[keyof GetObjectFolderResponses];
export type PatchObjectFolderData = {
body?: ObjectFolder;
path: {
objectFolderId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-folders/{objectFolderId}';
};
export type PatchObjectFolderResponses = {
/**
* default response
*/
default: ObjectFolder;
};
export type PatchObjectFolderResponse = PatchObjectFolderResponses[keyof PatchObjectFolderResponses];
export type PutObjectFolderData = {
body?: ObjectFolder;
path: {
objectFolderId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-folders/{objectFolderId}';
};
export type PutObjectFolderResponses = {
/**
* default response
*/
default: ObjectFolder;
};
export type PutObjectFolderResponse = PutObjectFolderResponses[keyof PutObjectFolderResponses];
export type DeleteObjectFolderBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-folders/batch';
};
export type DeleteObjectFolderBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostObjectFolderBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-folders/batch';
};
export type PostObjectFolderBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutObjectFolderBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-folders/batch';
};
export type PutObjectFolderBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectFolderByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-folders/by-external-reference-code/{externalReferenceCode}';
};
export type GetObjectFolderByExternalReferenceCodeResponses = {
/**
* default response
*/
default: ObjectFolder;
};
export type GetObjectFolderByExternalReferenceCodeResponse = GetObjectFolderByExternalReferenceCodeResponses[keyof GetObjectFolderByExternalReferenceCodeResponses];
export type PutObjectFolderByExternalReferenceCodeData = {
body?: ObjectFolder;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-folders/by-external-reference-code/{externalReferenceCode}';
};
export type PutObjectFolderByExternalReferenceCodeResponses = {
/**
* default response
*/
default: ObjectFolder;
};
export type PutObjectFolderByExternalReferenceCodeResponse = PutObjectFolderByExternalReferenceCodeResponses[keyof PutObjectFolderByExternalReferenceCodeResponses];
export type GetObjectFoldersPageData = {
body?: never;
path?: never;
query?: {
page?: string;
pageSize?: string;
search?: string;
nestedFields?: string;
};
url: '/o/object-admin/v1.0/object-folders';
};
export type GetObjectFoldersPageResponses = {
/**
* default response
*/
default: PageObjectFolder;
};
export type GetObjectFoldersPageResponse = GetObjectFoldersPageResponses[keyof GetObjectFoldersPageResponses];
export type PostObjectFolderData = {
body?: ObjectFolder;
path?: never;
query?: never;
url: '/o/object-admin/v1.0/object-folders';
};
export type PostObjectFolderResponses = {
/**
* default response
*/
default: ObjectFolder;
};
export type PostObjectFolderResponse = PostObjectFolderResponses[keyof PostObjectFolderResponses];
export type PostObjectFoldersPageExportBatchData = {
body?: never;
path?: never;
query?: {
search?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/object-admin/v1.0/object-folders/export-batch';
};
export type PostObjectFoldersPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteObjectLayoutData = {
body?: never;
path: {
objectLayoutId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-layouts/{objectLayoutId}';
};
export type DeleteObjectLayoutResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectLayoutData = {
body?: never;
path: {
objectLayoutId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-layouts/{objectLayoutId}';
};
export type GetObjectLayoutResponses = {
/**
* default response
*/
default: ObjectLayout;
};
export type GetObjectLayoutResponse = GetObjectLayoutResponses[keyof GetObjectLayoutResponses];
export type PutObjectLayoutData = {
body?: ObjectLayout;
path: {
objectLayoutId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-layouts/{objectLayoutId}';
};
export type PutObjectLayoutResponses = {
/**
* default response
*/
default: ObjectLayout;
};
export type PutObjectLayoutResponse = PutObjectLayoutResponses[keyof PutObjectLayoutResponses];
export type DeleteObjectLayoutBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-layouts/batch';
};
export type DeleteObjectLayoutBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutObjectLayoutBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-layouts/batch';
};
export type PutObjectLayoutBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectDefinitionByExternalReferenceCodeObjectLayoutsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/object-admin/v1.0/object-definitions/by-external-reference-code/{externalReferenceCode}/object-layouts';
};
export type GetObjectDefinitionByExternalReferenceCodeObjectLayoutsPageResponses = {
/**
* default response
*/
default: PageObjectLayout;
};
export type GetObjectDefinitionByExternalReferenceCodeObjectLayoutsPageResponse = GetObjectDefinitionByExternalReferenceCodeObjectLayoutsPageResponses[keyof GetObjectDefinitionByExternalReferenceCodeObjectLayoutsPageResponses];
export type PostObjectDefinitionByExternalReferenceCodeObjectLayoutData = {
body?: ObjectLayout;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/by-external-reference-code/{externalReferenceCode}/object-layouts';
};
export type PostObjectDefinitionByExternalReferenceCodeObjectLayoutResponses = {
/**
* default response
*/
default: ObjectLayout;
};
export type PostObjectDefinitionByExternalReferenceCodeObjectLayoutResponse = PostObjectDefinitionByExternalReferenceCodeObjectLayoutResponses[keyof PostObjectDefinitionByExternalReferenceCodeObjectLayoutResponses];
export type GetObjectDefinitionObjectLayoutsPageData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: {
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-layouts';
};
export type GetObjectDefinitionObjectLayoutsPageResponses = {
/**
* default response
*/
default: PageObjectLayout;
};
export type GetObjectDefinitionObjectLayoutsPageResponse = GetObjectDefinitionObjectLayoutsPageResponses[keyof GetObjectDefinitionObjectLayoutsPageResponses];
export type PostObjectDefinitionObjectLayoutData = {
body?: ObjectLayout;
path: {
objectDefinitionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-layouts';
};
export type PostObjectDefinitionObjectLayoutResponses = {
/**
* default response
*/
default: ObjectLayout;
};
export type PostObjectDefinitionObjectLayoutResponse = PostObjectDefinitionObjectLayoutResponses[keyof PostObjectDefinitionObjectLayoutResponses];
export type PostObjectDefinitionObjectLayoutBatchData = {
body?: {
[key: string]: unknown;
};
path: {
objectDefinitionId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-layouts/batch';
};
export type PostObjectDefinitionObjectLayoutBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostObjectDefinitionObjectLayoutsPageExportBatchData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: {
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-layouts/export-batch';
};
export type PostObjectDefinitionObjectLayoutsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteObjectRelationshipData = {
body?: never;
path: {
objectRelationshipId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-relationships/{objectRelationshipId}';
};
export type DeleteObjectRelationshipResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectRelationshipData = {
body?: never;
path: {
objectRelationshipId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-relationships/{objectRelationshipId}';
};
export type GetObjectRelationshipResponses = {
/**
* default response
*/
default: ObjectRelationship;
};
export type GetObjectRelationshipResponse = GetObjectRelationshipResponses[keyof GetObjectRelationshipResponses];
export type PutObjectRelationshipData = {
body?: ObjectRelationship;
path: {
objectRelationshipId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-relationships/{objectRelationshipId}';
};
export type PutObjectRelationshipResponses = {
/**
* default response
*/
default: ObjectRelationship;
};
export type PutObjectRelationshipResponse = PutObjectRelationshipResponses[keyof PutObjectRelationshipResponses];
export type DeleteObjectRelationshipBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-relationships/batch';
};
export type DeleteObjectRelationshipBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutObjectRelationshipBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-relationships/batch';
};
export type PutObjectRelationshipBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectDefinitionByExternalReferenceCodeObjectRelationshipsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/object-admin/v1.0/object-definitions/by-external-reference-code/{externalReferenceCode}/object-relationships';
};
export type GetObjectDefinitionByExternalReferenceCodeObjectRelationshipsPageResponses = {
/**
* default response
*/
default: PageObjectRelationship;
};
export type GetObjectDefinitionByExternalReferenceCodeObjectRelationshipsPageResponse = GetObjectDefinitionByExternalReferenceCodeObjectRelationshipsPageResponses[keyof GetObjectDefinitionByExternalReferenceCodeObjectRelationshipsPageResponses];
export type PostObjectDefinitionByExternalReferenceCodeObjectRelationshipData = {
body?: ObjectRelationship;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/by-external-reference-code/{externalReferenceCode}/object-relationships';
};
export type PostObjectDefinitionByExternalReferenceCodeObjectRelationshipResponses = {
/**
* default response
*/
default: ObjectRelationship;
};
export type PostObjectDefinitionByExternalReferenceCodeObjectRelationshipResponse = PostObjectDefinitionByExternalReferenceCodeObjectRelationshipResponses[keyof PostObjectDefinitionByExternalReferenceCodeObjectRelationshipResponses];
export type GetObjectDefinitionObjectRelationshipsPageData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-relationships';
};
export type GetObjectDefinitionObjectRelationshipsPageResponses = {
/**
* default response
*/
default: PageObjectRelationship;
};
export type GetObjectDefinitionObjectRelationshipsPageResponse = GetObjectDefinitionObjectRelationshipsPageResponses[keyof GetObjectDefinitionObjectRelationshipsPageResponses];
export type PostObjectDefinitionObjectRelationshipData = {
body?: ObjectRelationship;
path: {
objectDefinitionId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-relationships';
};
export type PostObjectDefinitionObjectRelationshipResponses = {
/**
* default response
*/
default: ObjectRelationship;
};
export type PostObjectDefinitionObjectRelationshipResponse = PostObjectDefinitionObjectRelationshipResponses[keyof PostObjectDefinitionObjectRelationshipResponses];
export type PostObjectDefinitionObjectRelationshipBatchData = {
body?: {
[key: string]: unknown;
};
path: {
objectDefinitionId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-relationships/batch';
};
export type PostObjectDefinitionObjectRelationshipBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostObjectDefinitionObjectRelationshipsPageExportBatchData = {
body?: never;
path: {
objectDefinitionId: string;
};
query?: {
filter?: string;
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/object-admin/v1.0/object-definitions/{objectDefinitionId}/object-relationships/export-batch';
};
export type PostObjectDefinitionObjectRelationshipsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutObjectRelationshipByExternalReferenceCodeData = {
body?: ObjectRelationship;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-relationships/by-external-reference-code/{externalReferenceCode}';
};
export type PutObjectRelationshipByExternalReferenceCodeResponses = {
/**
* default response
*/
default: ObjectRelationship;
};
export type PutObjectRelationshipByExternalReferenceCodeResponse = PutObjectRelationshipByExternalReferenceCodeResponses[keyof PutObjectRelationshipByExternalReferenceCodeResponses];
export type DeleteObjectValidationRuleData = {
body?: never;
path: {
objectValidationRuleId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-validation-rules/{objectValidationRuleId}';
};
export type DeleteObjectValidationRuleResponses = {
/**
* default response
*/
default: unknown;
};
export type GetObjectValidationRuleData = {
body?: never;
path: {
objectValidationRuleId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-validation-rules/{objectValidationRuleId}';
};
export type GetObjectValidationRuleResponses = {
/**
* default response
*/
default: ObjectValidationRule;
};
export type GetObjectValidationRuleResponse = GetObjectValidationRuleResponses[keyof GetObjectValidationRuleResponses];
export type PatchObjectValidationRuleData = {
body?: ObjectValidationRule;
path: {
objectValidationRuleId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-validation-rules/{objectValidationRuleId}';
};
export type PatchObjectValidationRuleResponses = {
/**
* default response
*/
default: ObjectValidationRule;
};
export type PatchObjectValidationRuleResponse = PatchObjectValidationRuleResponses[keyof PatchObjectValidationRuleResponses];
export type PutObjectValidationRuleData = {
body?: ObjectValidationRule;
path: {
objectValidationRuleId: string;
};
query?: never;
url: '/o/object-admin/v1.0/object-validation-rules/{objectValidationRuleId}';
};
export type PutObjectValidationRuleResponses = {
/**
* default response
*/
default: ObjectValidationRule;
};
export type PutObjectValidationRuleResponse = PutObjectValidationRuleResponses[keyof PutObjectValidationRuleResponses];
export type DeleteObjectValidationRuleBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/object-admin/v1.0/object-validation-rules/batch';
};
export type DeleteObjectValidationRuleBatchResponses = {
/**
* default response
*/
default: unknown;
};
expor