Jump to

• Request
• Response

Register a Workflow

post

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

Request

Supported Media Types

• application/json

Query Parameters

• 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

Header Parameters

• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Register a workflow in OCE.

Root 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"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created.

Body ()

Root 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"
}

400 Response

Bad request.

404 Response

Not found.

500 Response

Internal server error.

Back to Top