Jump to

• Request
• Response

Update ProjectProfile

put

/projectProfile

Send a request to this endpoint to update one or more ProjectProfile. An application object will be created for each JSON object provided in the request body

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of projectProfile objects.

Root Schema : List<ProjectProfile>

Type: array

Title: List<ProjectProfile>

Show Source

• Array of: object ProjectProfile
  Title: ProjectProfile

  ProjectProfile Entity

{
    "title":"List<ProjectProfile>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProjectProfile"
    }
}

Nested Schema : ProjectProfile

Type: object

Title: ProjectProfile

ProjectProfile Entity

Show Source

• CreateDate: string (date-time)
  The date this project profile was created.
• CreateUser: string
  The name of the user that created this project profile.
• IsDefault: boolean
  The flag that indicates this security profile is the default profile assigned to UserOBS objects. When a ProjectProfile object is deleted from the database, all UserOBS objects assigned to that profile are reassigned to the default profile. You cannot not delete the default profile.
• IsSuperUser: boolean
  The flag that indicates this is the project superuser profile, which gives a user read/write privileges for all project and OBS specific information and features
• LastUpdateDate: string (date-time)
  The date this project profile was last updated.
• LastUpdateUser: string
  The name of the user that last updated this project profile.
• Name(required): string
  The unique name of this project profile
• ObjectId: integer (int32)
  The unique ID generated by the system.
• Privilege: array Privilege
  Privilege

{
    "title":"ProjectProfile",
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this project profile was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this project profile."
        },
        "IsDefault":{
            "type":"boolean",
            "description":"The flag that indicates this security profile is the default profile assigned to UserOBS objects. When a ProjectProfile object is deleted from the database, all UserOBS objects assigned to that profile are reassigned to the default profile. You cannot not delete the default profile."
        },
        "IsSuperUser":{
            "type":"boolean",
            "description":"The flag that indicates this is the project superuser profile, which gives a user read/write privileges for all project and OBS specific information and features"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this project profile was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this project profile."
        },
        "Name":{
            "type":"string",
            "description":"The unique name of this project profile"
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "Privilege":{
            "type":"array",
            "description":"Privilege",
            "items":{
                "$ref":"#/components/schemas/Privilege"
            }
        }
    },
    "description":"ProjectProfile Entity"
}

Nested Schema : Privilege

Type: array

Privilege

Show Source

• Array of: object Privilege
  Privilege

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

Nested Schema : Privilege

Type: object

Privilege

Show Source

• Has: boolean
• Name: string

{
    "type":"object",
    "properties":{
        "Has":{
            "type":"boolean"
        },
        "Name":{
            "type":"string"
        }
    },
    "description":"Privilege"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : schema

Type: boolean

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top