Skip to content

Variable: FieldCapabilityPayloadSchema ​

ts
const FieldCapabilityPayloadSchema: ZodObject<{
  customFieldDefinitions: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     cfType: ZodOptional<ZodString>;
     description: ZodOptional<ZodString>;
     name: ZodOptional<ZodString>;
     onConflict: ZodOptional<ZodCustom<... & ... | "FAIL" | "USE" | "NEW", ... & ... | "FAIL" | "USE" | "NEW">>;
     pcri: ZodOptional<ZodObject<{
        anID: ZodOptional<...>;
        areference: ZodOptional<...>;
        entityId: ZodOptional<...>;
        entityType: ZodOptional<...>;
        id: ZodOptional<...>;
        type: ZodOptional<...>;
     }, ApiObjectConfig<undefined>>>;
     scope: ZodOptional<ZodCustom<... & ... | "PROJECT" | "TEMPLATE" | "GLOBAL", ... & ... | "PROJECT" | "TEMPLATE" | "GLOBAL">>;
     searcherKey: ZodOptional<ZodString>;
  }, ApiObjectConfig<undefined>>>>>;
  fieldLayoutScheme: ZodOptional<ZodObject<{
     defaultFieldLayout: ZodOptional<ZodObject<{
        anID: ZodOptional<ZodBoolean>;
        areference: ZodOptional<ZodBoolean>;
        entityId: ZodOptional<ZodString>;
        entityType: ZodOptional<ZodString>;
        id: ZodOptional<ZodString>;
        type: ZodOptional<ZodCustom<... | ... | ..., ... | ... | ...>>;
     }, ApiObjectConfig<undefined>>>;
     description: ZodOptional<ZodString>;
     explicitMappings: ZodOptional<ZodRecord<ZodString, ZodObject<{
        anID: ZodOptional<ZodBoolean>;
        areference: ZodOptional<ZodBoolean>;
        entityId: ZodOptional<ZodString>;
        entityType: ZodOptional<ZodString>;
        id: ZodOptional<ZodString>;
        type: ZodOptional<ZodCustom<..., ...>>;
     }, ApiObjectConfig<undefined>>>>;
     name: ZodOptional<ZodString>;
     pcri: ZodOptional<ZodObject<{
        anID: ZodOptional<ZodBoolean>;
        areference: ZodOptional<ZodBoolean>;
        entityId: ZodOptional<ZodString>;
        entityType: ZodOptional<ZodString>;
        id: ZodOptional<ZodString>;
        type: ZodOptional<ZodCustom<... | ... | ..., ... | ... | ...>>;
     }, ApiObjectConfig<undefined>>>;
  }, ApiObjectConfig<undefined>>>;
  fieldScheme: ZodOptional<ZodObject<{
     description: ZodOptional<ZodString>;
     items: ZodOptional<ZodArray<ZodObject<{
        description: ZodOptional<ZodString>;
        pcri: ZodOptional<ZodObject<..., ...>>;
        qualifierId: ZodOptional<ZodObject<..., ...>>;
        qualifierType: ZodOptional<ZodObject<..., ...>>;
        rendererType: ZodOptional<ZodString>;
        required: ZodOptional<ZodBoolean>;
     }, ApiObjectConfig<undefined>>>>;
     name: ZodOptional<ZodString>;
     onConflict: ZodOptional<ZodCustom<string & object | "FAIL" | "USE" | "NEW", string & object | "FAIL" | "USE" | "NEW">>;
     pcri: ZodOptional<ZodObject<{
        anID: ZodOptional<ZodBoolean>;
        areference: ZodOptional<ZodBoolean>;
        entityId: ZodOptional<ZodString>;
        entityType: ZodOptional<ZodString>;
        id: ZodOptional<ZodString>;
        type: ZodOptional<ZodCustom<... | ... | ..., ... | ... | ...>>;
     }, ApiObjectConfig<undefined>>>;
  }, ApiObjectConfig<undefined>>>;
  issueLayouts: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     containerId: ZodOptional<ZodObject<{
        anID: ZodOptional<...>;
        areference: ZodOptional<...>;
        entityId: ZodOptional<...>;
        entityType: ZodOptional<...>;
        id: ZodOptional<...>;
        type: ZodOptional<...>;
     }, ApiObjectConfig<undefined>>>;
     issueLayoutType: ZodOptional<ZodCustom<... & ... | "ISSUE_VIEW" | "ISSUE_CREATE" | "REQUEST_FORM", ... & ... | "ISSUE_VIEW" | "ISSUE_CREATE" | "REQUEST_FORM">>;
     items: ZodOptional<ZodArray<ZodObject<{
        itemKey: ...;
        properties: ...;
        sectionType: ...;
        type: ...;
     }, ApiObjectConfig<...>>>>;
     pcri: ZodOptional<ZodObject<{
        anID: ZodOptional<...>;
        areference: ZodOptional<...>;
        entityId: ZodOptional<...>;
        entityType: ZodOptional<...>;
        id: ZodOptional<...>;
        type: ZodOptional<...>;
     }, ApiObjectConfig<undefined>>>;
  }, ApiObjectConfig<undefined>>>>>;
  issueTypeScreenScheme: ZodOptional<ZodObject<{
     defaultScreenScheme: ZodOptional<ZodObject<{
        anID: ZodOptional<ZodBoolean>;
        areference: ZodOptional<ZodBoolean>;
        entityId: ZodOptional<ZodString>;
        entityType: ZodOptional<ZodString>;
        id: ZodOptional<ZodString>;
        type: ZodOptional<ZodCustom<... | ... | ..., ... | ... | ...>>;
     }, ApiObjectConfig<undefined>>>;
     description: ZodOptional<ZodString>;
     explicitMappings: ZodOptional<ZodRecord<ZodString, ZodObject<{
        anID: ZodOptional<ZodBoolean>;
        areference: ZodOptional<ZodBoolean>;
        entityId: ZodOptional<ZodString>;
        entityType: ZodOptional<ZodString>;
        id: ZodOptional<ZodString>;
        type: ZodOptional<ZodCustom<..., ...>>;
     }, ApiObjectConfig<undefined>>>>;
     name: ZodOptional<ZodString>;
     pcri: ZodOptional<ZodObject<{
        anID: ZodOptional<ZodBoolean>;
        areference: ZodOptional<ZodBoolean>;
        entityId: ZodOptional<ZodString>;
        entityType: ZodOptional<ZodString>;
        id: ZodOptional<ZodString>;
        type: ZodOptional<ZodCustom<... | ... | ..., ... | ... | ...>>;
     }, ApiObjectConfig<undefined>>>;
  }, ApiObjectConfig<undefined>>>;
  screens: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     description: ZodOptional<ZodString>;
     name: ZodOptional<ZodString>;
     pcri: ZodOptional<ZodObject<{
        anID: ZodOptional<...>;
        areference: ZodOptional<...>;
        entityId: ZodOptional<...>;
        entityType: ZodOptional<...>;
        id: ZodOptional<...>;
        type: ZodOptional<...>;
     }, ApiObjectConfig<undefined>>>;
     tabs: ZodOptional<ZodArray<ZodObject<{
        fields: ...;
        name: ...;
     }, ApiObjectConfig<...>>>>;
  }, ApiObjectConfig<undefined>>>>>;
  screenScheme: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     defaultScreen: ZodOptional<ZodObject<{
        anID: ZodOptional<...>;
        areference: ZodOptional<...>;
        entityId: ZodOptional<...>;
        entityType: ZodOptional<...>;
        id: ZodOptional<...>;
        type: ZodOptional<...>;
     }, ApiObjectConfig<undefined>>>;
     description: ZodOptional<ZodString>;
     name: ZodOptional<ZodString>;
     pcri: ZodOptional<ZodObject<{
        anID: ZodOptional<...>;
        areference: ZodOptional<...>;
        entityId: ZodOptional<...>;
        entityType: ZodOptional<...>;
        id: ZodOptional<...>;
        type: ZodOptional<...>;
     }, ApiObjectConfig<undefined>>>;
     screens: ZodOptional<ZodRecord<ZodString, ZodObject<{
        anID: ...;
        areference: ...;
        entityId: ...;
        entityType: ...;
        id: ...;
        type: ...;
     }, ApiObjectConfig<...>>>>;
  }, ApiObjectConfig<undefined>>>>>;
}, ApiObjectConfig<undefined>>;

Defined in: src/cloud/models/fieldCapabilityPayload.ts:15

Defines the payload for the fields, screens, screen schemes, issue type screen schemes, field layouts, and field layout schemes