Jump to

• Request
• Response
• Examples

Get a case household

get

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds/{CaseHouseholdId}

Request

Path Parameters

• CaseHouseholdId(required): integer(int64)
  The unique identifier of the case household.
• CaseNumber(required): string
  The alternate key identifier of the case.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

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 : cases-caseHouseholds-item-response

Type: object

Show Source

• CaseHouseholdId: integer (int64)
  Title: Household ID

  Read Only: true

  The unique identifier of the case household.
• CaseId: integer (int64)
  Title: Case ID

  The unique identifier of the case.
• CaseNumber: string
  Title: Case Number

  Maximum Length: 30

  The alternate key identifier of the case.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the household for the case.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the case household was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DeleteFlag: boolean
  Title: Delete

  Read Only: true

  Indicates whether the record can be deleted.
• HouseholdName: string
  Title: Household Name

  Maximum Length: 360

  The name of the household.
• HouseholdPartyNumber: string
  Title: Household Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the household party.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the household for the case was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the household for the case.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the household for the case.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party.
• PrimaryFlag: boolean
  Title: Primary Household

  Read Only: true

  Indicates whether the household is the primary household for the case.
• UpdateFlag: boolean
  Title: Update

  Read Only: true

  Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "CaseHouseholdId":{
            "title":"Household ID",
            "type":"integer",
            "description":"The unique identifier of the case household.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the household for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case household was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HouseholdName":{
            "title":"Household Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the household.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "HouseholdPartyNumber":{
            "title":"Household Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the household party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the household for the case was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the household for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the household for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Household",
            "type":"boolean",
            "description":"Indicates whether the household is the primary household for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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."
        }
    }
}

Links

HouseholdVO

Operation: /crmRestApi/resources/11.13.18.05/households

An object that includes attributes used to store values while creating or updating a household. A household is a group that has a relationship with either an account or a contact.

Back to Top

Examples

The following example shows how to get a case household by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds/{CaseHouseholdId}

Example of Response Body

The following shows an example of the response body in JSON format.

  {
    "CaseHouseholdId": 300100215793300,
    "CaseId": 300100215793299,
    "CorpCurrencyCode": null,
    "CreatedBy": "AUTOUICASE1",
    "CreationDate": "2021-08-23T06:29:08+00:00",
    "CurcyConvRateType": null,
    "CurrencyCode": null,
    "LastUpdateDate": "2021-08-23T06:29:08.589+00:00",
    "LastUpdateLogin": "C9E50EC5A48BEE00E05323EAF40A1FFD",
    "LastUpdatedBy": "AUTOUICASE1",
    "PartyId": 100100035557303,
    "HouseholdPartyNumber": "IMP_GRP_11_",
    "HouseholdName": "IMP_GRP_34",
    "CaseNumber": "CDRM_4003",
    "PrimaryFlag": false,
    "UpdateFlag": true,
    "DeleteFlag": true,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseHouseholds/300100215793300",
            "name": "caseHouseholds",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseHouseholds/300100215793300",
            "name": "caseHouseholds",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003",
            "name": "cases",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseHouseholds/300100215793300/lov/HouseholdVO",
            "name": "HouseholdVO",
            "kind": "collection"
        }
    ]
}

Back to Top