Jump to

• Request
• Response

Create a case code reference

post

/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences

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)
  Default Value: 1

  The agency identifier of the case code reference.
• CaseKey: integer (int64)
  The unique identifier of the case.
• CasePuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier of the migrated case record.
• CodeReferenceCode: string
  Maximum Length: 100

  The identifier of the violation code reference.
• CodeReferenceDescription: string (byte)
  The description of the violation code reference.
• CodeReferenceKey: integer (int64)
  The unique identifier of the case code reference.
• CodeReferenceName: string
  Maximum Length: 200

  The name of the violation code reference.
• CodeReferencePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case code reference record.
• CorrectiveActionCode: string
  Maximum Length: 100

  The identifier of the corrective action.
• CorrectiveActionDescription: string (byte)
  The description of the corrective action.
• CorrectiveActionName: string
  Maximum Length: 200

  The name of the corrective action.
• SourceInspectionKey: integer (int64)
  The unique identifier of the code enforcement inspection.
• SourceInspectionPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated code enforcement inspection record.
• Status: string
  Maximum Length: 8

  Default Value: ORA_OPEN

  Indicates the status code of the code violation.

{
    "type":"object",
    "properties":{
        "SourceInspectionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated code enforcement inspection record.",
            "nullable":true
        },
        "Status":{
            "maxLength":8,
            "type":"string",
            "description":"Indicates the status code of the code violation.",
            "nullable":false,
            "default":"ORA_OPEN"
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the case code reference.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "CodeReferenceCode":{
            "maxLength":100,
            "type":"string",
            "description":"The identifier of the violation code reference.",
            "nullable":false
        },
        "CorrectiveActionName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the corrective action.",
            "nullable":true
        },
        "CodeReferencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case code reference record.",
            "nullable":false
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false,
            "default":" "
        },
        "CorrectiveActionDescription":{
            "type":"string",
            "description":"The description of the corrective action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CorrectiveActionCode":{
            "maxLength":100,
            "type":"string",
            "description":"The identifier of the corrective action.",
            "nullable":true
        },
        "SourceInspectionKey":{
            "type":"integer",
            "description":"The unique identifier of the code enforcement inspection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CodeReferenceDescription":{
            "type":"string",
            "description":"The description of the violation code reference.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CodeReferenceKey":{
            "type":"integer",
            "description":"The unique identifier of the case code reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CodeReferenceName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the violation code reference.",
            "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 : publicSectorCaseCodeReferences-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency identifier of the case code reference.
• CaseId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the case.
• CaseKey: integer (int64)
  The unique identifier of the case.
• CasePuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier of the migrated case record.
• CodeReferenceCode: string
  Maximum Length: 100

  The identifier of the violation code reference.
• CodeReferenceDescription: string (byte)
  The description of the violation code reference.
• CodeReferenceKey: integer (int64)
  The unique identifier of the case code reference.
• CodeReferenceName: string
  Maximum Length: 200

  The name of the violation code reference.
• CodeReferencePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case code reference record.
• CorrectiveActionCode: string
  Maximum Length: 100

  The identifier of the corrective action.
• CorrectiveActionDescription: string (byte)
  The description of the corrective action.
• CorrectiveActionName: string
  Maximum Length: 200

  The name of the corrective action.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceInspectionKey: integer (int64)
  The unique identifier of the code enforcement inspection.
• SourceInspectionPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated code enforcement inspection record.
• Status: string
  Maximum Length: 8

  Default Value: ORA_OPEN

  Indicates the status code of the code violation.
• StatusText: string
  Read Only: true

  Maximum Length: 255

  Indicates the status text of the code violation.

{
    "type":"object",
    "properties":{
        "SourceInspectionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated code enforcement inspection record.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":8,
            "type":"string",
            "description":"Indicates the status code of the code violation.",
            "nullable":false,
            "default":"ORA_OPEN",
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the case code reference.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "StatusText":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the status text of the code violation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CodeReferenceCode":{
            "maxLength":100,
            "type":"string",
            "description":"The identifier of the violation code reference.",
            "nullable":false,
            "x-queryable":true
        },
        "CorrectiveActionName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the corrective action.",
            "nullable":true,
            "x-queryable":true
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CodeReferencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case code reference record.",
            "nullable":false,
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "CorrectiveActionDescription":{
            "type":"string",
            "description":"The description of the corrective action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CorrectiveActionCode":{
            "maxLength":100,
            "type":"string",
            "description":"The identifier of the corrective action.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceInspectionKey":{
            "type":"integer",
            "description":"The unique identifier of the code enforcement inspection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CodeReferenceDescription":{
            "type":"string",
            "description":"The description of the violation code reference.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CodeReferenceKey":{
            "type":"integer",
            "description":"The unique identifier of the case code reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CodeReferenceName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the violation code reference.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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