Jump to

• Request
• Response

Get all responsible parties

get

/fscmRestApi/resources/11.13.18.05/publicSectorResponsibleParties

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 responsible party that matches the specified search criteria. Finder Variables:
    • CaseContactKey; integer; The unique identifier of the responsible party.
    • CaseKey; integer; The unique identifier of the case.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorResponsibleParties

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorResponsibleParties-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorResponsibleParties-item

{
    "items":{
        "$ref":"#/definitions/publicSectorResponsibleParties-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : publicSectorResponsibleParties-item

Type: object

Show Source

• AccessComments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments for the case online access request.
• AccessStatus(optional): string
  Title: Online Access Status

  Maximum Length: 30

  The status of the case online access.
• AccessStatusDesc(optional): string
  Title: Access Status Description

  Maximum Length: 80

  The status description of the case online access.
• Address1(optional): string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the address of the case contact.
• Address2(optional): string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the address of the case contact.
• Address3(optional): string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the address of the case contact.
• Address4(optional): string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the address of the case contact.
• CaseContactKey(optional): integer(int64)
  The unique identifier of the case contact.
• CaseContactPuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case contact.
• CaseId(optional): string
  Title: Case ID

  Maximum Length: 50

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

  The public unique identifier of the migrated case.
• City(optional): string
  Title: City

  Maximum Length: 60

  The city of the case contact.
• ClaimantUserName(optional): string
  Title: User Name

  The user ID of the online case access requestor.
• ContactPartyId(optional): integer(int64)
  Title: Contact Party

  The party ID of the case contact.
• ContactType(optional): string
  Title: Type

  Maximum Length: 15

  The type of contact for the case.
• ContactTypeDesc(optional): string
  Title: Contact Type Description

  Maximum Length: 80

  The description of contact type for the case.
• Country(optional): string
  Title: Country

  Maximum Length: 3

  The country of the case contact.
• County(optional): string
  Title: County

  Maximum Length: 60

  The county of the case contact.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• EmailAddress(optional): string
  Title: Email

  Maximum Length: 254

  The email address of the case contact.
• IssueSubtype(optional): string
  Title: Issue Subtype

  Maximum Length: 100

  The name of the issue subtype associated with the case.
• IssueSubtypeId(optional): string
  Title: Issue Subtype ID

  Maximum Length: 50

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

  Maximum Length: 100

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

  Maximum Length: 50

  The unique identifier of the issue type of the case.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• PersonFirstName(optional): string
  Title: First Name

  Maximum Length: 150

  The first name of the case contact.
• PersonLastName(optional): string
  Title: Last Name

  Maximum Length: 150

  The last name of the case contact.
• PersonMiddleName(optional): string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the case contact.
• PersonNameSuffix(optional): string
  Title: Name Suffix

  Maximum Length: 30

  The suffix of the case contact.
• PersonTitle(optional): string
  Title: Title

  Maximum Length: 60

  The title of the case contact.
• PhoneNumber(optional): string
  Title: Phone

  Maximum Length: 100

  The phone number of the case contact.
• PostalCode(optional): string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the case contact.
• PostalPlus4Code(optional): string
  Title: Postal Plus 4 Code

  Maximum Length: 10

  The postal plus code of the case contact.
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates if the contact is the primary case contact.
• Province(optional): string
  Title: Province

  Maximum Length: 60

  The province of case contact.
• State(optional): string
  Title: State

  Maximum Length: 60

  The state of the case contact.
• UserFirstName(optional): string
  Title: Applicant First Name

  Maximum Length: 150

  The first name of the online case access requestor.
• UserLastName(optional): string
  Title: Applicant Last Name

  Maximum Length: 150

  The last name of the online case access requestor.

{
    "properties":{
        "AccessComments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments for the case online access request.",
            "title":"Comments"
        },
        "AccessStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the case online access.",
            "title":"Online Access Status"
        },
        "AccessStatusDesc":{
            "maxLength":80,
            "type":"string",
            "description":"The status description of the case online access.",
            "title":"Access Status Description"
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address of the case contact.",
            "title":"Address Line 1"
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address of the case contact.",
            "title":"Address Line 2"
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address of the case contact.",
            "title":"Address Line 3"
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address of the case contact.",
            "title":"Address Line 4"
        },
        "CaseContactKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case contact."
        },
        "CaseContactPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case contact."
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the case.",
            "title":"Case ID"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the case contact.",
            "title":"City"
        },
        "ClaimantUserName":{
            "type":"string",
            "description":"The user ID of the online case access requestor.",
            "title":"User Name"
        },
        "ContactPartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The party ID of the case contact.",
            "title":"Contact Party"
        },
        "ContactType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of contact for the case.",
            "title":"Type"
        },
        "ContactTypeDesc":{
            "maxLength":80,
            "type":"string",
            "description":"The description of contact type for the case.",
            "title":"Contact Type Description"
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the case contact.",
            "title":"Country"
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the case contact.",
            "title":"County"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EmailAddress":{
            "maxLength":254,
            "type":"string",
            "description":"The email address of the case contact.",
            "title":"Email"
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the issue subtype associated with the case.",
            "title":"Issue Subtype"
        },
        "IssueSubtypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the issue subtype of the case.",
            "title":"Issue Subtype ID"
        },
        "IssueType":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the issue type associated with the case.",
            "title":"Issue Type"
        },
        "IssueTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the issue type of the case.",
            "title":"Issue Type ID"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the case contact.",
            "title":"First Name"
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the case contact.",
            "title":"Last Name"
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the case contact.",
            "title":"Middle Name"
        },
        "PersonNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"The suffix of the case contact.",
            "title":"Name Suffix"
        },
        "PersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The title of the case contact.",
            "title":"Title"
        },
        "PhoneNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The phone number of the case contact.",
            "title":"Phone"
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the case contact.",
            "title":"Postal Code"
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the case contact.",
            "title":"Postal Plus 4 Code"
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the contact is the primary case contact.",
            "title":"Primary"
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of case contact.",
            "title":"Province"
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the case contact.",
            "title":"State"
        },
        "UserFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the online case access requestor.",
            "title":"Applicant First Name"
        },
        "UserLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the online case access requestor.",
            "title":"Applicant Last Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top