Jump to

• Request
• Response

Update a project

patch

https://{your_site_interface}/opa-hub/api/12.2.35/projects/{project-name}

This operation will update a project.

Request

Path Parameters

• project-name(required): string
  The name of the project.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• name: string
  The name of the project.
• transaction: object transaction
  Additional Properties Allowed: true

  Transaction to apply to the project draft.
• workspace: string
  Workspace of which the project is a member.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the project."
        },
        "workspace":{
            "type":"string",
            "description":"Workspace of which the project is a member."
        },
        "transaction":{
            "type":"object",
            "description":"Transaction to apply to the project draft.",
            "additionalProperties":true
        }
    }
}

Nested Schema : transaction

Type: object

Additional Properties Allowed: true

Transaction to apply to the project draft.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : project

Type: object

Show Source

• icon: string
  The icon for the project.
• inclusions-report: object projectInclusionsReport
• kind: string
  Allowed Values: [ "policy-model", "decision", "flow", "flowScheme" ]

  The kind of the project.
• lastChanged: string (date-time)
  Read Only: true

  Time the project was last changed
• lastChangedBy: string
  Read Only: true

  User that made the last change
• name: string
  The name of the project.
• transaction: object transaction
  Additional Properties Allowed: true

  Transaction to apply to the project draft.
• versions: object projectVersions
• workspace: string
  Workspace of which the project is a member.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the project."
        },
        "kind":{
            "type":"string",
            "description":"The kind of the project.",
            "enum":[
                "policy-model",
                "decision",
                "flow",
                "flowScheme"
            ]
        },
        "workspace":{
            "type":"string",
            "description":"Workspace of which the project is a member."
        },
        "lastChanged":{
            "type":"string",
            "format":"date-time",
            "description":"Time the project was last changed",
            "readOnly":true
        },
        "lastChangedBy":{
            "type":"string",
            "description":"User that made the last change",
            "readOnly":true
        },
        "icon":{
            "type":"string",
            "description":"The icon for the project."
        },
        "transaction":{
            "type":"object",
            "description":"Transaction to apply to the project draft.",
            "additionalProperties":true
        },
        "versions":{
            "$ref":"#/components/schemas/projectVersions"
        },
        "inclusions-report":{
            "readOnly":true,
            "$ref":"#/components/schemas/projectInclusionsReport"
        }
    }
}

Nested Schema : projectInclusionsReport

Type: object

Show Source

• inclusions: array inclusions
  Read Only: true

  Contains a flat array of all the project names and versions included by this project.

{
    "type":"object",
    "properties":{
        "inclusions":{
            "type":"array",
            "description":"Contains a flat array of all the project names and versions included by this project.",
            "readOnly":true,
            "items":{
                "description":"An inclusion for a project.",
                "$ref":"#/components/schemas/projectInclusionsReportInclusion"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : transaction

Type: object

Additional Properties Allowed: true

Transaction to apply to the project draft.

Nested Schema : projectVersions

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/projectVersion"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : inclusions

Type: array

Read Only: true

Contains a flat array of all the project names and versions included by this project.

Show Source

• Array of: object projectInclusionsReportInclusion

{
    "type":"array",
    "description":"Contains a flat array of all the project names and versions included by this project.",
    "readOnly":true,
    "items":{
        "description":"An inclusion for a project.",
        "$ref":"#/components/schemas/projectInclusionsReportInclusion"
    }
}

Nested Schema : projectInclusionsReportInclusion

Type: object

Show Source

• inclusionLatestVersion: integer (int64)
  The latest version of the included project.
• inclusionName(required): string
  The name of the included project.
• inclusionVersion(required): integer (int64)
  The version of the included project.
• projectName(required): string
  The name of the including project.
• projectVersion(required): integer (int64)
  The version of the including project.
• upToDateFlag(required): boolean
  A flag indicating whether the included project is the latest version.

{
    "type":"object",
    "properties":{
        "projectName":{
            "type":"string",
            "description":"The name of the including project."
        },
        "projectVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The version of the including project."
        },
        "inclusionName":{
            "type":"string",
            "description":"The name of the included project."
        },
        "inclusionVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The version of the included project."
        },
        "inclusionLatestVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The latest version of the included project."
        },
        "upToDateFlag":{
            "type":"boolean",
            "description":"A flag indicating whether the included project is the latest version."
        }
    },
    "additionalProperties":false,
    "required":[
        "inclusionVersion",
        "upToDateFlag",
        "projectName",
        "projectVersion",
        "inclusionName"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object projectVersion

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/projectVersion"
    }
}

Nested Schema : projectVersion

Type: object

Show Source

• author: string
  Read Only: true

  The author of this version.
• createTimestamp: string (date-time)
  Read Only: true

  The date and time the version was created
• definition: object definition
  The definition of the decision service, which must conform to the Decision Service project format.
• definitionHash: string
  Read Only: true

  The hash of the definition.
• description: string
  The description of this version, if the project kind is "policy-model".
• descriptionAuthor: string
  If the description has been updated, the author of the updated description.
• descriptionUpdatedAt: string (date-time)
  If the description has been updated, the date and time of its last update.
• inclusions-report: object projectVersionInclusionsReport
• isDraft: boolean
  If true, the version is a draft and may be overwritten on the next save.
• lastDefinitionHash: string
  Required on POST unless the version is for a new project. This must be the hash of the existing unpublished definition if one exists, otherwise the latest published definition hash. Not returned on GET.
• snapshot: string (byte)
  The base-64 data, if the project kind is "policy-model".

  Example: QmFzZS02NCBkYXRhLg==
• version: integer (int64)
  Read Only: true

  The automatically assigned version number

{
    "type":"object",
    "properties":{
        "version":{
            "type":"integer",
            "format":"int64",
            "description":"The automatically assigned version number",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "description":"The description of this version, if the project kind is \"policy-model\"."
        },
        "descriptionUpdatedAt":{
            "type":"string",
            "format":"date-time",
            "description":"If the description has been updated, the date and time of its last update."
        },
        "descriptionAuthor":{
            "type":"string",
            "description":"If the description has been updated, the author of the updated description."
        },
        "definition":{
            "type":"object",
            "description":"The definition of the decision service, which must conform to the <a href=\"https://documentation.custhelp.com/euf/assets/devdocs/unversioned/IntelligentAdvisor/en/Content/Guides/Customize_extend/Administration/Dec_serv_project_format.htm\">Decision Service project format</a>."
        },
        "snapshot":{
            "type":"string",
            "format":"byte",
            "description":"The base-64 data, if the project kind is \"policy-model\".",
            "example":"QmFzZS02NCBkYXRhLg=="
        },
        "inclusions-report":{
            "readOnly":true,
            "$ref":"#/components/schemas/projectVersionInclusionsReport"
        },
        "isDraft":{
            "type":"boolean",
            "description":"If true, the version is a draft and may be overwritten on the next save."
        },
        "createTimestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the version was created",
            "readOnly":true
        },
        "definitionHash":{
            "type":"string",
            "description":"The hash of the definition.",
            "readOnly":true
        },
        "lastDefinitionHash":{
            "type":"string",
            "description":"Required on POST unless the version is for a new project. This must be the hash of the existing unpublished definition if one exists, otherwise the latest published definition hash. Not returned on GET."
        },
        "author":{
            "type":"string",
            "description":"The author of this version.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Nested Schema : definition

Type: object

The definition of the decision service, which must conform to the Decision Service project format.

Nested Schema : projectVersionInclusionsReport

Type: object

Show Source

• inclusions: array inclusions
  Read Only: true

  Contains a flat array of all the project names and versions included by this project version.

{
    "type":"object",
    "properties":{
        "inclusions":{
            "type":"array",
            "description":"Contains a flat array of all the project names and versions included by this project version.",
            "readOnly":true,
            "items":{
                "description":"An inclusion for a project version.",
                "$ref":"#/components/schemas/projectVersionInclusionsReportInclusion"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : inclusions

Type: array

Read Only: true

Contains a flat array of all the project names and versions included by this project version.

Show Source

• Array of: object projectVersionInclusionsReportInclusion

{
    "type":"array",
    "description":"Contains a flat array of all the project names and versions included by this project version.",
    "readOnly":true,
    "items":{
        "description":"An inclusion for a project version.",
        "$ref":"#/components/schemas/projectVersionInclusionsReportInclusion"
    }
}

Nested Schema : projectVersionInclusionsReportInclusion

Type: object

Show Source

• inclusionLatestVersion: integer (int64)
  The latest version of the included project.
• inclusionName(required): string
  The name of the included project.
• inclusionVersion(required): integer (int64)
  The version of the included project.
• projectName(required): string
  The name of the including project.
• projectVersion(required): integer (int64)
  The version of the including project.
• upToDateFlag(required): boolean
  A flag indicating whether the included project is the latest version.

{
    "type":"object",
    "properties":{
        "projectName":{
            "type":"string",
            "description":"The name of the including project."
        },
        "projectVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The version of the including project."
        },
        "inclusionName":{
            "type":"string",
            "description":"The name of the included project."
        },
        "inclusionVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The version of the included project."
        },
        "inclusionLatestVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The latest version of the included project."
        },
        "upToDateFlag":{
            "type":"boolean",
            "description":"A flag indicating whether the included project is the latest version."
        }
    },
    "additionalProperties":false,
    "required":[
        "inclusionVersion",
        "upToDateFlag",
        "projectName",
        "projectVersion",
        "inclusionName"
    ]
}

Back to Top