NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Update a profile template

put

/spms/v1/profileConfigurations/list

This is to update a profile template

Request

Supported Media Types

• application/json

Body ()

Required fields to create profile template

Root Schema : schema

Type: array

Show Source

• Array of: object ProfileConfigurationsWithId
  Profile templates

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProfileConfigurationsWithId"
    }
}

Nested Schema : ProfileConfigurationsWithId

Type: object

Profile templates

Show Source

• enabled(optional): boolean
  Indicates whether this field is enabled or not

  Example: true
• id(optional): integer
  Minimum Value: 1

  This is the profile template primary key

  Example: 1
• mandatory(optional): boolean
  Indicates whether this column is mandatory

  Example: true
• profileConfigurationId(optional): integer
  Minimum Value: 1

  Indicates which category of profile template it belongs to

  Example: 1
• profileId(optional): integer
  Minimum Value: 1

  This is the id of a profile type

  Example: 1

{
    "description":"Profile templates",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is the profile template primary key"
        },
        "profileId":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is the id of a profile type"
        },
        "profileConfigurationId":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"Indicates which category of profile template it belongs to"
        },
        "mandatory":{
            "type":"boolean",
            "example":true,
            "description":"Indicates whether this column is mandatory"
        },
        "enabled":{
            "type":"boolean",
            "example":true,
            "description":"Indicates whether this field is enabled or not"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns a profile template based on the id

Body ()

Root Schema : ProfileConfigurationsWithId

Type: object

Profile templates

Show Source

• enabled(optional): boolean
  Indicates whether this field is enabled or not

  Example: true
• id(optional): integer
  Minimum Value: 1

  This is the profile template primary key

  Example: 1
• mandatory(optional): boolean
  Indicates whether this column is mandatory

  Example: true
• profileConfigurationId(optional): integer
  Minimum Value: 1

  Indicates which category of profile template it belongs to

  Example: 1
• profileId(optional): integer
  Minimum Value: 1

  This is the id of a profile type

  Example: 1

{
    "description":"Profile templates",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is the profile template primary key"
        },
        "profileId":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is the id of a profile type"
        },
        "profileConfigurationId":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"Indicates which category of profile template it belongs to"
        },
        "mandatory":{
            "type":"boolean",
            "example":true,
            "description":"Indicates whether this column is mandatory"
        },
        "enabled":{
            "type":"boolean",
            "example":true,
            "description":"Indicates whether this field is enabled or not"
        }
    }
}

400 Response

The supplied parameter(s) is not valid

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

401 Response

You are not authorized to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

403 Response

You are forbidden to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

404 Response

The profile template does not exist

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

405 Response

This method is not available

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

406 Response

Mandatory field cannot be modified

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

415 Response

The media supplied is not supported

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occurred while processing this request

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top