Skip to content

Variable: WorkflowCapabilityPayloadSchema ​

ts
const WorkflowCapabilityPayloadSchema: ZodObject<{
  statuses: ZodOptional<ZodArray<ZodObject<{
     description: ZodOptional<ZodString>;
     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>>>;
     scope: ZodOptional<ZodNullable<ZodCustom<... & ... | "GLOBAL", ... & ... | "GLOBAL">>>;
     statusCategory: ZodOptional<ZodCustom<string & object | "TODO" | "IN_PROGRESS" | "DONE", string & object | "TODO" | "IN_PROGRESS" | "DONE">>;
  }, ApiObjectConfig<undefined>>>>;
  workflows: ZodOptional<ZodArray<ZodObject<{
     description: ZodOptional<ZodString>;
     loopedTransitionContainerLayout: ZodOptional<ZodObject<{
        x: ZodOptional<ZodNumber>;
        y: ZodOptional<ZodNumber>;
     }, 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>>>;
     startPointLayout: ZodOptional<ZodObject<{
        x: ZodOptional<ZodNumber>;
        y: ZodOptional<ZodNumber>;
     }, ApiObjectConfig<undefined>>>;
     statuses: ZodOptional<ZodArray<ZodObject<{
        layout: ZodOptional<...>;
        pcri: ZodOptional<...>;
        properties: ZodOptional<...>;
     }, ApiObjectConfig<undefined>>>>;
     transitions: ZodOptional<ZodArray<ZodObject<{
        actions: ZodOptional<...>;
        conditions: ZodOptional<...>;
        customIssueEventId: ZodOptional<...>;
        description: ZodOptional<...>;
        from: ZodOptional<...>;
        id: ZodOptional<...>;
        name: ZodOptional<...>;
        properties: ZodOptional<...>;
        to: ZodOptional<...>;
        transitionScreen: ZodOptional<...>;
        triggers: ZodOptional<...>;
        type: ZodOptional<...>;
        validators: ZodOptional<...>;
     }, ApiObjectConfig<undefined>>>>;
  }, ApiObjectConfig<undefined>>>>;
  workflowScheme: ZodOptional<ZodObject<{
     defaultWorkflow: 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>;
     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>>>;
}, ApiObjectConfig<undefined>>;

Defined in: src/cloud/models/workflowCapabilityPayload.ts:11

The payload for creating a workflows. See https://www.atlassian.com/software/jira/guides/workflows/overview#what-is-a-jira-workflow