Jump to

• Request
• Response

List All Workflows

get

/content/management/api/v1.1/workflows

List all Workflows.

Request

Query Parameters

• fields(optional): string
  This parameter is used to control the returned fields in each workflow in the list. This parameter accepts a comma-separated list of field names or all. These fields will be returned for each workflow in the list. All the field names are case-sensitive, users must provide the correct field names in the query. Each workflow has both standard fields (id, name, description, applicationName, revision, source, externalId, isEnabled, createdBy, createdDate, updatedBy, updatedDate) and additional fields (repositories, roles, properties)' When fields is specified as all (in lower case), all the standard and additional fields are returned. The standard fields are always returned in the response and cannot be filtered out. The user can filter out only the additional fields. This parameter is optional in the query, and by default the result shows only standard fields in the response. Any incorrect or invalid field name given in the query will throw an error.
  
  Example: ?fields=repositories,roles,properties
  This returns all standard fields along with the repositories , properties and roles additional fields for each workflow.
  Example: ?fields=all
  This will return all standard fields and all additional fields for each workflow.
  
• limit(optional): integer(int32)
  This parameter accepts a non negative integer and is used to control the size of the result.

  Default Value: 100
• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby
• offset(optional): integer(int32)
  This parameter accepts a non negative integer and is used to control the start index of the result.

  Default Value: 0
• orderBy(optional): string
  This parameter is used to control order of results. The value of this query parameter follow the format of fieldName:[asc/desc]. asc stands for ascending order desc stands for descending order, default order is asc.The only fields allowed in the field name are name and updatedDate.

  Default Value: name:asc
• q(optional): string
  This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using AND/OR operators and grouped with parentheses. The value of query condition follows the format of {fieldName} {operator} "{fieldValue}". ???isEnabled eq "true" or isEnabled eq "false" and/or roleName eq "viewer or contributor or manager" and/or name co "workflowName" and/or repositoryId eq "RepoId" are the conditions supported in this version. All the field names are optional. roleName defaults to roleName eq "viewer" which filters the workflows with at least given role. name is interpreted in the context of the resource being requested. For eg. name for workflows implies workflow name.
  Example:
  ?q=isEnabled eq "true")

  Default Value: roleName eq "viewer"
• totalResults(optional): boolean
  This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : Workflows

Type: object

Workflows

Show Source

• aggregationResults(optional): array aggregationResults
  Aggregation results.
• count(optional): integer(int32)
  Total number of records in the current response.
• hasMore(optional): boolean
  Check whether there are more pages to fetch.
• items(optional): array items
  Singular resources contained in the collection.
• limit(optional): integer(int32)
  Actual page size used by the server. This might not be the same as what the client requests.
• links(optional): array links
  Links of the resource.
• offset(optional): integer(int32)
  The actual index from which the singular resources are returned.
• pinned(optional): array pinned
  Pinned items. Shows items pinned at the top of search list
• scrollId(optional): string
  scrollId if the search resolved to a scroll search.
• totalResults(optional): integer(int32)
  Total number of rows that satisfy the client request (excluding the paging parameters.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/Workflow"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Workflows"
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object Workflow
  Workflow

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/Workflow"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : AggregationResult

Type: object

Show Source

• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : Workflow

Type: object

Workflow

Show Source

• applicationName(optional): string
  Application Name of the Workflow.
• createdBy(optional): string
  createdBy user of the Repository.
• createdDate(optional): object date
  date
• description(optional): string
  Description of the Workflow.
• externalId(optional): string
  External id coming from source. It is a required property in post request.
• id(optional): string
  id of the Workflow.
• isEnabled(optional): boolean
  If workflow is enabled or disabled in OCE.
• links(optional): array links
  Links
• name(optional): string
  Name of the Workflow.
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties

  Properties of a workflow.
• repositories(optional): array repositories
  Assigned repositories of a workflow.
• revision(optional): string
  Revision of the Workflow.
• roleName(optional): string
  Name of the user's role on the workflow.
• roles(optional): array roles
  Roles of a workflow.
• source(optional): string
  Source of the workflow. It is a required property in post Request.
• updatedBy(optional): string
  updatedBy user of the Repository.
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the Workflow."
        },
        "name":{
            "type":"string",
            "description":"Name of the Workflow."
        },
        "description":{
            "type":"string",
            "description":"Description of the Workflow."
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name of the Workflow."
        },
        "revision":{
            "type":"string",
            "description":"Revision of the Workflow."
        },
        "externalId":{
            "type":"string",
            "description":"External id coming from source. It is a required property in post request."
        },
        "source":{
            "type":"string",
            "description":"Source of the workflow. It is a required property in post Request."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"If workflow is enabled or disabled in OCE."
        },
        "properties":{
            "type":"object",
            "description":"Properties of a workflow.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "repositories":{
            "type":"array",
            "description":"Assigned repositories of a workflow.",
            "items":{
                "$ref":"#/definitions/RepositoryId"
            }
        },
        "roles":{
            "type":"array",
            "description":"Roles of a workflow.",
            "items":{
                "type":"string"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the workflow."
        },
        "createdBy":{
            "type":"string",
            "description":"createdBy user of the Repository."
        },
        "createdDate":{
            "description":"date and time Repository createdDate.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updatedBy user of the Repository."
        },
        "updatedDate":{
            "description":"date and time Repository updatedDate.",
            "$ref":"#/definitions/date"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Workflow"
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Properties of a workflow.",
    "additionalProperties":{
        "type":"object"
    }
}

Properties of a workflow.

Nested Schema : repositories

Type: array

Assigned repositories of a workflow.

Show Source

• Array of: object RepositoryId
  RepositoryId

{
    "type":"array",
    "description":"Assigned repositories of a workflow.",
    "items":{
        "$ref":"#/definitions/RepositoryId"
    }
}

Nested Schema : roles

Type: array

Roles of a workflow.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Roles of a workflow.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : additionalProperties

Type: object

Nested Schema : RepositoryId

Type: object

RepositoryId

Show Source

• id(optional): string
• name(optional): string
  Name of the repository. It is a required property in the get response and post/put request.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"Name of the repository. It is a required property in the get response and post/put request."
        }
    },
    "description":"RepositoryId"
}

304 Response

Not modified.

400 Response

Bad request.

500 Response

Internal server error.

Back to Top