Jump to

• Request
• Response

Create a report configuration parameter

post

/fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency that is associated with the report.
• MappedControlName: string
  Title: Control Name

  Maximum Length: 150

  The name of the control object that is mapped to the report. A control object is a field from which the report parameter receives data.
• MappedControlObjname: string
  Title: Control Object

  Maximum Length: 150

  The control object that is mapped to the report. A control object is a field from which the report parameter receives data.
• ReportControlId: string
  Title: Report ID

  Maximum Length: 32

  The unique identifier of the report.
• ReportParamDatatype: string
  Title: Parameter Data Type

  Maximum Length: 150

  The data type of the parameter added to the report.
• ReportParamId: integer (int32)
  Title: Parameter ID

  The unique identifier of the parameter added to the report.
• ReportParamName: string
  Title: Parameter Name

  Maximum Length: 150

  The name of the parameter added to the report.

{
    "type":"object",
    "properties":{
        "ReportControlId":{
            "title":"Report ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the report.",
            "nullable":false
        },
        "ReportParamName":{
            "title":"Parameter Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the parameter added to the report.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with the report.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "MappedControlName":{
            "title":"Control Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the control object that is mapped to the report. A control object is a field from which the report parameter receives data.",
            "nullable":true
        },
        "ReportParamId":{
            "title":"Parameter ID",
            "type":"integer",
            "description":"The unique identifier of the parameter added to the report.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "MappedControlObjname":{
            "title":"Control Object",
            "maxLength":150,
            "type":"string",
            "description":"The control object that is mapped to the report. A control object is a field from which the report parameter receives data.",
            "nullable":true
        },
        "ReportParamDatatype":{
            "title":"Parameter Data Type",
            "maxLength":150,
            "type":"string",
            "description":"The data type of the parameter added to the report.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorBIPReportParameters-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency that is associated with the report.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the report configuration parameter.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the report configuration parameter was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time that the report configuration parameter was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the report configuration parameter.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappedControlName: string
  Title: Control Name

  Maximum Length: 150

  The name of the control object that is mapped to the report. A control object is a field from which the report parameter receives data.
• MappedControlObjname: string
  Title: Control Object

  Maximum Length: 150

  The control object that is mapped to the report. A control object is a field from which the report parameter receives data.
• ReportControlId: string
  Title: Report ID

  Maximum Length: 32

  The unique identifier of the report.
• ReportParamDatatype: string
  Title: Parameter Data Type

  Maximum Length: 150

  The data type of the parameter added to the report.
• ReportParamId: integer (int32)
  Title: Parameter ID

  The unique identifier of the parameter added to the report.
• ReportParamName: string
  Title: Parameter Name

  Maximum Length: 150

  The name of the parameter added to the report.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the report configuration parameter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the report configuration parameter was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportControlId":{
            "title":"Report ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the report.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the report configuration parameter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportParamName":{
            "title":"Parameter Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the parameter added to the report.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with the report.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "MappedControlName":{
            "title":"Control Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the control object that is mapped to the report. A control object is a field from which the report parameter receives data.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportParamId":{
            "title":"Parameter ID",
            "type":"integer",
            "description":"The unique identifier of the parameter added to the report.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MappedControlObjname":{
            "title":"Control Object",
            "maxLength":150,
            "type":"string",
            "description":"The control object that is mapped to the report. A control object is a field from which the report parameter receives data.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the report configuration parameter was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportParamDatatype":{
            "title":"Parameter Data Type",
            "maxLength":150,
            "type":"string",
            "description":"The data type of the parameter added to the report.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top