Jump to

• Request
• Response

Create one conformance parameter.

post

/fscmRestApi/resources/11.13.18.05/conformanceParameters

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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 ()

Root Schema : schema

Type: object

Show Source

• ConformanceParameterId: integer (int64)
  Identifier of the conformance parameter.
• DataType: string
  Maximum Length: 30

  Data type of the parameter.
• DecimalPrecision: integer (int64)
  Decimal precision for displayed values.
• EnabledFlag: boolean
  Maximum Length: 1

  Flag that indicates whether the parameter is enabled.
• MaximumValue: number
  Maximum acceptable value of the parameter.
• MinimumValue: number
  Minimum acceptable value of the parameter.
• OrganizationId: integer (int64)
  Organization associated with the parameter.
• ParameterCode: string
  Maximum Length: 30

  Code of the conformance parameter.
• ParameterDescription: string
  Maximum Length: 400

  Description of the conformance parameter.
• UOMCode: string
  Maximum Length: 3

  Unit of measure code.

{
    "type":"object",
    "properties":{
        "ConformanceParameterId":{
            "type":"integer",
            "description":"Identifier of the conformance parameter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DataType":{
            "maxLength":30,
            "type":"string",
            "description":"Data type of the parameter.",
            "nullable":false
        },
        "DecimalPrecision":{
            "type":"integer",
            "description":"Decimal precision for displayed values.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Flag that indicates whether the parameter is enabled.",
            "nullable":false
        },
        "MaximumValue":{
            "type":"number",
            "description":"Maximum acceptable value of the parameter.",
            "nullable":false
        },
        "MinimumValue":{
            "type":"number",
            "description":"Minimum acceptable value of the parameter.",
            "nullable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Organization associated with the parameter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ParameterCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the conformance parameter.",
            "nullable":false
        },
        "ParameterDescription":{
            "maxLength":400,
            "type":"string",
            "description":"Description of the conformance parameter.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure code.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : conformanceParameters-item-response

Type: object

Show Source

• ConformanceParameterId: integer (int64)
  Identifier of the conformance parameter.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time record was created.
• DataType: string
  Maximum Length: 30

  Data type of the parameter.
• DataTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Display meaning of the data type.
• DecimalPrecision: integer (int64)
  Decimal precision for displayed values.
• EnabledFlag: boolean
  Maximum Length: 1

  Flag that indicates whether the parameter is enabled.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time record was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Record version number for locking.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login session used for last update.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumValue: number
  Maximum acceptable value of the parameter.
• MinimumValue: number
  Minimum acceptable value of the parameter.
• OrganizationId: integer (int64)
  Organization associated with the parameter.
• ParameterCode: string
  Maximum Length: 30

  Code of the conformance parameter.
• ParameterDescription: string
  Maximum Length: 400

  Description of the conformance parameter.
• UOMCode: string
  Maximum Length: 3

  Unit of measure code.
• UOMMeaning: string
  Read Only: true

  Maximum Length: 25

  Meaning of the unit of measure.

{
    "type":"object",
    "properties":{
        "ConformanceParameterId":{
            "type":"integer",
            "description":"Identifier of the conformance parameter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataType":{
            "maxLength":30,
            "type":"string",
            "description":"Data type of the parameter.",
            "nullable":false,
            "x-queryable":true
        },
        "DataTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Display meaning of the data type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DecimalPrecision":{
            "type":"integer",
            "description":"Decimal precision for displayed values.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Flag that indicates whether the parameter is enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time record was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login session used for last update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Record version number for locking.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumValue":{
            "type":"number",
            "description":"Maximum acceptable value of the parameter.",
            "nullable":false,
            "x-queryable":true
        },
        "MinimumValue":{
            "type":"number",
            "description":"Minimum acceptable value of the parameter.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Organization associated with the parameter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParameterCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the conformance parameter.",
            "nullable":false,
            "x-queryable":true
        },
        "ParameterDescription":{
            "maxLength":400,
            "type":"string",
            "description":"Description of the conformance parameter.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure code.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMMeaning":{
            "maxLength":25,
            "type":"string",
            "description":"Meaning of the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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