Jump to

• Request
• Response

Get all case attachment communications

get

/fscmRestApi/resources/11.13.18.05/publicSectorCaseAttachmentCommunications

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the case attachment communication that matches the specified search criteria.
    Finder Variables:
    • AttachmentId; integer; The unique identifier of the case communication attachment content.
    • CaseKey; integer; The unique identifier of the case attachment communication.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AttachmentId; integer; The identifier of the case attachment communication.
  • AttachmentKey; integer; The unique identifier of the case attachment communication.
  • CaseContactKey; integer; The unique identifier of the contact person associated with the case.
  • CaseContactPartyId; number; The identifier of the contact person associated with the case.
  • CaseContactPersonFirstName; string; The first name of the contact person associated with the case.
  • CaseContactPersonLastName; string; The last name of the contact person associated with the case.
  • CaseId; string; The identifier of the case communication.
  • CaseKey; integer; The unique identifier of the case communication.
  • CodeOfficerEmail; string; The email address of the code officer assigned to the case.
  • CodeOfficerId; string; The unique identifier of the code officer assigned to the case.
  • CodeOfficerPhone; string; The phone number of the code officer assigned to the case.
  • CodeTechnicianEmail; string; The email address of the code technician assigned to the case.
  • CodeTechnicianId; string; The unique identifier of the code technician assigned to the case.
  • CodeTechnicianPhone; string; The phone number of the code technician assigned to the case.
  • CreationDate; string; The date and time when the row was created.
  • DocCategory; string; The document category of the case attachment communication.
  • DocCategoryCode; string; The document category code of the case attachment communication.
  • DocSubcategory; string; The document subcategory of the case attachment communication.
  • DocSubcategoryCode; string; The document subcategory code of the case attachment communication.
  • FileDescription; string; The description of the case attachment communication file.
  • FileName; string; The name of the case attachment file communication.
  • FileSize; integer; File size of the case attachment communication.
  • FileType; string; File type of the case attachment communication.
  • FunctionalStatus; string; The user defined case status name that maps to a delivered system status.
  • IssueDescription; string; The description of the case.
  • IssueSubtype; string; The name of the issue subtype associated with the case.
  • IssueSubtypeDescription; string; The description of the issue subtype of the case.
  • IssueSubtypeId; string; The unique identifier of the issue subtype of the case.
  • IssueType; string; The name of the issue type associated with the case.
  • IssueTypeId; string; The unique identifier of the issue type of the case.
  • Status; string; The status of the case.
  • StatusName; string; The status name of the case.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : publicSectorCaseAttachmentCommunications

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCaseAttachmentCommunications-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"CodeEnforcement",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorCaseAttachmentCommunications-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCaseAttachmentCommunications-item-response"
    }
}

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 : publicSectorCaseAttachmentCommunications-item-response

Type: object

Show Source

• AttachmentId: integer (int64)
  Read Only: true

  The identifier of the case attachment communication.
• AttachmentKey: integer
  Read Only: true

  The unique identifier of the case attachment communication.
• CaseContactKey: integer (int64)
  Read Only: true

  The unique identifier of the contact person associated with the case.
• CaseContactPartyId: number
  Read Only: true

  The identifier of the contact person associated with the case.
• CaseContactPersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the contact person associated with the case.
• CaseContactPersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the contact person associated with the case.
• CaseId: string
  Title: Case ID

  Read Only: true

  Maximum Length: 50

  The identifier of the case communication.
• CaseKey: integer (int64)
  Read Only: true

  The unique identifier of the case communication.
• CodeOfficerEmail: string
  Title: Code Officer Email

  Read Only: true

  Maximum Length: 240

  The email address of the code officer assigned to the case.
• CodeOfficerId: string
  Title: Inspector Assigned

  Read Only: true

  Maximum Length: 100

  The unique identifier of the code officer assigned to the case.
• CodeOfficerPhone: string
  Title: Code Officer Phone Number

  Read Only: true

  Maximum Length: 60

  The phone number of the code officer assigned to the case.
• CodeTechnicianEmail: string
  Title: Code Technician Email

  Read Only: true

  Maximum Length: 240

  The email address of the code technician assigned to the case.
• CodeTechnicianId: string
  Title: Technician Assigned

  Read Only: true

  Maximum Length: 100

  The unique identifier of the code technician assigned to the case.
• CodeTechnicianPhone: string
  Title: Code Technician Phone

  Read Only: true

  Maximum Length: 60

  The phone number of the code technician assigned to the case.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• DocCategory: string
  Title: Category

  Read Only: true

  Maximum Length: 25

  The document category of the case attachment communication.
• DocCategoryCode: string
  Title: Category ID

  Read Only: true

  Maximum Length: 30

  The document category code of the case attachment communication.
• DocSubcategory: string
  Title: Subcategory

  Read Only: true

  Maximum Length: 25

  The document subcategory of the case attachment communication.
• DocSubcategoryCode: string
  Title: Subcategory ID

  Read Only: true

  Maximum Length: 30

  The document subcategory code of the case attachment communication.
• FileDescription: string
  Title: File Description

  Read Only: true

  Maximum Length: 100

  The description of the case attachment communication file.
• FileName: string
  Title: File Name

  Read Only: true

  Maximum Length: 255

  The name of the case attachment file communication.
• FileSize: integer (int64)
  Title: File Size

  Read Only: true

  File size of the case attachment communication.
• FileType: string
  Title: File Type

  Read Only: true

  Maximum Length: 100

  File type of the case attachment communication.
• FunctionalStatus: string
  Title: Transaction Status

  Read Only: true

  Maximum Length: 15

  The user defined case status name that maps to a delivered system status.
• IssueDescription: string
  Title: Issue Description

  Read Only: true

  Maximum Length: 1000

  The description of the case.
• IssueSubtype: string
  Title: Issue Subtype ID

  Read Only: true

  Maximum Length: 100

  The name of the issue subtype associated with the case.
• IssueSubtypeDescription: string
  Title: Issue Subtype Search Tags

  Read Only: true

  Maximum Length: 150

  The description of the issue subtype of the case.
• IssueSubtypeId: string
  Title: Issue Subtype Custom Id

  Read Only: true

  Maximum Length: 50

  The unique identifier of the issue subtype of the case.
• IssueType: string
  Title: Issue Type

  Read Only: true

  Maximum Length: 100

  The name of the issue type associated with the case.
• IssueTypeId: string
  Title: Issue Type ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the issue type of the case.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 15

  The status of the case.
• StatusName: string
  Title: Status Description

  Read Only: true

  Maximum Length: 30

  The status name of the case.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the case attachment file communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocCategoryCode":{
            "title":"Category ID",
            "maxLength":"30",
            "type":"string",
            "description":"The document category code of the case attachment communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocSubcategoryCode":{
            "title":"Subcategory ID",
            "maxLength":"30",
            "type":"string",
            "description":"The document subcategory code of the case attachment communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CodeTechnicianPhone":{
            "title":"Code Technician Phone",
            "maxLength":"60",
            "type":"string",
            "description":"The phone number of the code technician assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "title":"Issue Subtype Custom Id",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the issue subtype of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeDescription":{
            "title":"Issue Subtype Search Tags",
            "maxLength":"150",
            "type":"string",
            "description":"The description of the issue subtype of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentKey":{
            "type":"integer",
            "description":"The unique identifier of the case attachment communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseContactPersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the contact person associated with the case.",
            "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"
            }
        },
        "DocCategory":{
            "title":"Category",
            "maxLength":"25",
            "type":"string",
            "description":"The document category of the case attachment communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocSubcategory":{
            "title":"Subcategory",
            "maxLength":"25",
            "type":"string",
            "description":"The document subcategory of the case attachment communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalStatus":{
            "title":"Transaction Status",
            "maxLength":"15",
            "type":"string",
            "description":"The user defined case status name that maps to a delivered system status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "title":"Issue Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case communication.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"1",
                "precision":"18"
            },
            "x-queryable":true
        },
        "IssueType":{
            "title":"Issue Type",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the issue type associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "title":"Issue Subtype ID",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the issue subtype associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CodeOfficerId":{
            "title":"Inspector Assigned",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the code officer assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "IssueTypeId":{
            "title":"Issue Type ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the issue type of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CodeOfficerEmail":{
            "title":"Code Officer Email",
            "maxLength":"240",
            "type":"string",
            "description":"The email address of the code officer assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "CaseContactPersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the contact person associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier of the case communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Status Description",
            "maxLength":"30",
            "type":"string",
            "description":"The status name of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseContactPartyId":{
            "type":"number",
            "description":"The identifier of the contact person associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The identifier of the case attachment communication.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"2",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseContactKey":{
            "type":"integer",
            "description":"The unique identifier of the contact person associated with the case.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CodeOfficerPhone":{
            "title":"Code Officer Phone Number",
            "maxLength":"60",
            "type":"string",
            "description":"The phone number of the code officer assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "FileDescription":{
            "title":"File Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the case attachment communication file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileType":{
            "title":"File Type",
            "maxLength":"100",
            "type":"string",
            "description":"File type of the case attachment communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CodeTechnicianEmail":{
            "title":"Code Technician Email",
            "maxLength":"240",
            "type":"string",
            "description":"The email address of the code technician assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "CodeTechnicianId":{
            "title":"Technician Assigned",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the code technician assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"File size of the case attachment communication.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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