Jump to

• Request
• Response

Get all applications for an opportunity in opportunity marketplace

get

/hcmRestApi/resources/11.13.18.05/recruitingOppMktUserAppliedOpportunities

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 an application for an opportunity in opportunity marketplace using a unique ID.
    Finder Variables
    • GigApplicationId; integer; Finds an application for an opportunity in opportunity marketplace using a unique ID and the gig application ID.
  • findActiveApplications Finds all the active applications in opportunity marketplace.
    Finder Variables
  • findHistoryApplications Finds all the historical applications in opportunity marketplace.
    Finder Variables
• 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:
  

  • ApplicationDate; string; Application date of opportunities in Opportunity Marketplace.
  • EndDate; string; End date of an application for an opportunity in opportunity marketplace.
  • GigApplicationId; integer; Gig application ID of an application for an opportunity in opportunity marketplace.
  • GigApplicationStatus; string; Gig application status of an application for an opportunity in opportunity marketplace.
  • GigCreatorEmail; string; Gig creator email for an opportunity in opportunity marketplace.
  • GigCreatorId; integer; Gig creator ID of an application for an opportunity in opportunity marketplace.
  • GigCreatorName; string; Gig creator name of an application for an opportunity in opportunity marketplace.
  • GigId; integer; Gig ID of an application for an opportunity in opportunity marketplace.
  • GigNumber; string; Gig number in Opportunity Marketplace.
  • GigStatus; string; Gig status of an application for an opportunity in opportunity marketplace.
  • GigTitle; string; Gig title of an application for an opportunity in opportunity marketplace.
  • Location; string; Location of the gig in Opportunity Marketplace.
  • PersonId; integer; Person ID of an application for an opportunity in opportunity marketplace.
  • PostedDate; string; Posted date of an application for an opportunity in opportunity marketplace.
  • RemoteOpportunity; string; Remote opportunity indicator for user applied opportunity in Opportunity Marketplace.
  • StartDate; string; Start date of an application for an opportunity in opportunity marketplace.
  • TimeCommitment; integer; Time commitment for the gig in Opportunity Marketplace.
• 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 : recruitingOppMktUserAppliedOpportunities

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/recruitingOppMktUserAppliedOpportunities-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingOppMktUserAppliedOpportunities-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recruitingOppMktUserAppliedOpportunities-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 : recruitingOppMktUserAppliedOpportunities-item-response

Type: object

Show Source

• ApplicationDate: string (date-time)
  Title: Gig Application Date

  Read Only: true

  Application date of opportunities in Opportunity Marketplace.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  End date of an application for an opportunity in opportunity marketplace.
• GigApplicationId: integer
  Title: Application ID

  Read Only: true

  Gig application ID of an application for an opportunity in opportunity marketplace.
• GigApplicationStatus: string
  Title: Gig Application Status

  Read Only: true

  Maximum Length: 30

  Gig application status of an application for an opportunity in opportunity marketplace.
• GigCreatorEmail: string
  Title: Gig Manager Email

  Read Only: true

  Maximum Length: 255

  Gig creator email for an opportunity in opportunity marketplace.
• GigCreatorId: integer (int64)
  Title: Gig Manager

  Read Only: true

  Gig creator ID of an application for an opportunity in opportunity marketplace.
• GigCreatorName: string
  Title: Gig Manager

  Read Only: true

  Maximum Length: 240

  Gig creator name of an application for an opportunity in opportunity marketplace.
• GigId: integer
  Title: Gig ID

  Read Only: true

  Gig ID of an application for an opportunity in opportunity marketplace.
• GigNumber: string
  Title: Gig Number

  Read Only: true

  Maximum Length: 240

  Gig number in Opportunity Marketplace.
• GigStatus: string
  Title: Gig Status

  Read Only: true

  Maximum Length: 30

  Gig status of an application for an opportunity in opportunity marketplace.
• GigTitle: string
  Title: Gig Title

  Read Only: true

  Maximum Length: 240

  Gig title of an application for an opportunity in opportunity marketplace.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 255

  Location of the gig in Opportunity Marketplace.
• PersonId: integer (int64)
  Title: Gig Person ID

  Read Only: true

  Person ID of an application for an opportunity in opportunity marketplace.
• PostedDate: string (date)
  Title: Gig Posted Date

  Read Only: true

  Posted date of an application for an opportunity in opportunity marketplace.
• RemoteOpportunity: string
  Title: Remote Opportunity

  Read Only: true

  Maximum Length: 255

  Remote opportunity indicator for user applied opportunity in Opportunity Marketplace.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  Start date of an application for an opportunity in opportunity marketplace.
• TimeCommitment: integer (int32)
  Title: Hours per Week

  Read Only: true

  Time commitment for the gig in Opportunity Marketplace.

{
    "type":"object",
    "properties":{
        "GigApplicationId":{
            "title":"Application ID",
            "type":"integer",
            "description":"Gig application ID of an application for an opportunity in opportunity marketplace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GigCreatorId":{
            "title":"Gig Manager",
            "type":"integer",
            "description":"Gig creator ID of an application for an opportunity in opportunity marketplace.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GigTitle":{
            "title":"Gig Title",
            "maxLength":240,
            "type":"string",
            "description":"Gig title of an application for an opportunity in opportunity marketplace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RemoteOpportunity":{
            "title":"Remote Opportunity",
            "maxLength":255,
            "type":"string",
            "description":"Remote opportunity indicator for user applied opportunity in Opportunity Marketplace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of an application for an opportunity in opportunity marketplace.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationDate":{
            "title":"Gig Application Date",
            "type":"string",
            "description":"Application date of opportunities in Opportunity Marketplace.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of an application for an opportunity in opportunity marketplace.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GigApplicationStatus":{
            "title":"Gig Application Status",
            "maxLength":30,
            "type":"string",
            "description":"Gig application status of an application for an opportunity in opportunity marketplace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GigCreatorName":{
            "title":"Gig Manager",
            "maxLength":240,
            "type":"string",
            "description":"Gig creator name of an application for an opportunity in opportunity marketplace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeCommitment":{
            "title":"Hours per Week",
            "type":"integer",
            "description":"Time commitment for the gig in Opportunity Marketplace.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Gig Person ID",
            "type":"integer",
            "description":"Person ID of an application for an opportunity in opportunity marketplace.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GigId":{
            "title":"Gig ID",
            "type":"integer",
            "description":"Gig ID of an application for an opportunity in opportunity marketplace.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PostedDate":{
            "title":"Gig Posted Date",
            "type":"string",
            "description":"Posted date of an application for an opportunity in opportunity marketplace.",
            "format":"date",
            "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"
            }
        },
        "GigNumber":{
            "title":"Gig Number",
            "maxLength":240,
            "type":"string",
            "description":"Gig number in Opportunity Marketplace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GigStatus":{
            "title":"Gig Status",
            "maxLength":30,
            "type":"string",
            "description":"Gig status of an application for an opportunity in opportunity marketplace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GigCreatorEmail":{
            "title":"Gig Manager Email",
            "maxLength":255,
            "type":"string",
            "description":"Gig creator email for an opportunity in opportunity marketplace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "title":"Location",
            "maxLength":255,
            "type":"string",
            "description":"Location of the gig in Opportunity Marketplace.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "GeographyNodeId"
                ]
            },
            "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