Jump to

• Request
• Response

Add Report Groups

post

/config/sim/v1/setup/reportGroups

Add the Report Groups object to a specified hierarchy unit

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string(string)
  Detail that Identifies that who made the change

Body ()

CUD request Body

Root Schema : ReportGroupCUDRequestBody

Type: object

Model for Report Groups CUD Request Body

Show Source

• hierUnitId(required): integer
  Unique reference of the hierarchy unit where the Report Groups is configured

  Example: 3599
• name(required): object name
  A group of string objects representing the name of the Report Group in configured languages
• objectNum(required): integer
  Object Number of the Report Groups.

  Example: 1
• options: string
  A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Report Groups

  Example: 1000000000000000
• type: integer
  Type of the report group; 0 - None; 1 ??? Tender / Media; 2 ??? Discount; 3 ??? Service Charge

  Example: 1

{
    "description":"Model for Report Groups CUD Request Body",
    "type":"object",
    "required":[
        "objectNum",
        "hierUnitId",
        "name"
    ],
    "properties":{
        "objectNum":{
            "description":"Object Number of the Report Groups.",
            "type":"integer",
            "example":1
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the Report Groups is configured",
            "type":"integer",
            "example":3599
        },
        "name":{
            "description":"A group of string objects representing the name of the Report Group  in configured languages",
            "type":"object",
            "example":{
                "en-US":"Routing Group",
                "de-DE":"Routing-Gruppe"
            }
        },
        "options":{
            "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Report Groups",
            "type":"string",
            "example":"1000000000000000"
        },
        "type":{
            "description":"Type of the report group; 0 - None; 1 ??? Tender / Media; 2 ??? Discount; 3 ??? Service Charge",
            "type":"integer",
            "example":1
        }
    }
}

Nested Schema : name

Type: object

A group of string objects representing the name of the Report Group in configured languages

Example:

{
    "en-US":"Routing Group",
    "de-DE":"Routing-Gruppe"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Report Groups object of the organization.

Body ()

Root Schema : ReportGroupResponse

Type: object

Show Source

• hierUnitId(required): integer
  Unique hierarchy unit value

  Example: 1
• objectNum(required): integer
  Object number of the printer

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the printer",
            "type":"integer",
            "example":1
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top