Show Source

• items(required): array items
  List of approval process summaries.

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of approval process summaries.",
            "items":{
                "$ref":"#/definitions/ApprovalProcessSummary"
            }
        }
    },
    "description":"Results of a approval process search."
}

Show Source

• Array of: object ApprovalProcessSummary
  Summary of the AgcsApprovalProcess.

{
    "type":"array",
    "description":"List of approval process summaries.",
    "items":{
        "$ref":"#/definitions/ApprovalProcessSummary"
    }
}

Show Source

• creatorId(required): string
  The ID of the creator.
• displayName(required): string
  Minimum Length: 1

  Maximum Length: 100

  The approval process name, must be unique.
• guid(required): string
  The global identifier for the approval process definition.
• isDefault: boolean
  Set to true if the approval process is the default process.
• isInDraftMode(required): boolean
  Indicates whether a draft for the approval process is available.
• isRuntime: boolean
  Set to true if the approval process has configuration provided at runtime.
• ownedEntityId: string
  The ownership collection owned entity ID
• owner: object ApprovalProcessOwner
  Details of an approval process owner.
• ownershipCollectionId: string
  The ownership collection ID
• state(required): string
  Allowed Values: [ "DRAFT", "PUBLISHING", "ACTIVE", "DISABLED", "DELETING" ]

  The lifecycle state of the approval process.
• timeCreated(required): string(date-time)
  The time that the approval process was created.
• timeUpdated(required): string(date-time)
  The last update date of the process.
• updaterId(required): string
  User ID of last person that updated the process.
• version: integer
  The version of the approval process definition.

{
    "type":"object",
    "required":[
        "creatorId",
        "displayName",
        "guid",
        "isInDraftMode",
        "state",
        "timeCreated",
        "timeUpdated",
        "updaterId"
    ],
    "properties":{
        "guid":{
            "type":"string",
            "description":"The global identifier for the approval process definition."
        },
        "version":{
            "type":"integer",
            "description":"The version of the approval process definition."
        },
        "displayName":{
            "type":"string",
            "description":"The approval process name, must be unique.",
            "minLength":1,
            "maxLength":100
        },
        "state":{
            "type":"string",
            "description":"The lifecycle state of the approval process.",
            "enum":[
                "DRAFT",
                "PUBLISHING",
                "ACTIVE",
                "DISABLED",
                "DELETING"
            ],
            "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessState"
        },
        "isInDraftMode":{
            "type":"boolean",
            "description":"Indicates whether a draft for the approval process is available."
        },
        "creatorId":{
            "type":"string",
            "description":"The ID of the creator."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"The time that the approval process was created."
        },
        "updaterId":{
            "type":"string",
            "description":"User ID of last person that updated the process."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The last update date of the process."
        },
        "isRuntime":{
            "type":"boolean",
            "description":"Set to true if the approval process has configuration provided at runtime."
        },
        "isDefault":{
            "type":"boolean",
            "description":"Set to true if the approval process is the default process."
        },
        "ownershipCollectionId":{
            "type":"string",
            "description":"The ownership collection ID"
        },
        "ownedEntityId":{
            "type":"string",
            "description":"The ownership collection owned entity ID"
        },
        "owner":{
            "$ref":"#/definitions/ApprovalProcessOwner"
        }
    },
    "description":"Summary of the AgcsApprovalProcess."
}

Show Source

• displayName(required): string
  The display name of the identity.
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  User ID of the identity.
• isPrimary(required): boolean
  Set to true if the user is the primary owner, set to false otherwise.

{
    "type":"object",
    "required":[
        "displayName",
        "id",
        "isPrimary"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"User ID of the identity.",
            "minLength":1,
            "maxLength":255
        },
        "displayName":{
            "type":"string",
            "description":"The display name of the identity."
        },
        "isPrimary":{
            "type":"boolean",
            "description":"Set to true if the user is the primary owner, set to false otherwise."
        }
    },
    "description":"Details of an approval process owner."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}