Jump to

• Request
• Response

Get associated submitted forms

get

/rest/ofscCore/v1/activities/{activityId}/submittedForms

The function allows to retrieve all submitted data related to an activity or bundle of activities.

Request

Path Parameters

• activityId(required): integer
  The unique identifier of the activity in Oracle Field Service.

Query Parameters

• bundle: string
  Label of a bundling rule. The parameter allows to specify the label of the bundle to filter the returned data. Only submitted forms related to a specific bundle will be present in the response. If the parameter is not specified, all the submitted forms related to all bundles will be returned. This parameter is not allowed if the 'scope' parameter has value 'activity'. Default: all the submitted forms related to all bundles related to the activity will be returned
• limit: integer
  The number of items to be returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.
• offset: integer
  The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
• scope: string
  Scope. Whether to return submitted forms related only to the activity or to all bundled activities. If the value is 'activity', all data of all submitted forms related to the activity is returned. If the value is 'bundles' then only submitted forms related to configured bundles are returned. Allowed values [ activity, bundles ]. Default: bundles

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : submittedForms

Type: object

The collection of associated submitted forms that are registered for the activity.

Show Source

• hasMore: boolean
  Title: Has More Results

  Contains one of the following values: true or false. If true, then there are more results that can be retrieved with successive paging requests. If false or if the value is not present, then there are no more results or this is the final page. The default value is true.
• items: array Items
  Title: Items

  The collection of associated submitted forms that are registered for the activity.
• limit: integer
  Title: Limit

  The limit value specified in the request (May be different form specified in the request parameter).
• offset: integer
  Title: Offset

  The offset value specified in the request.
• totalResults: integer
  Title: Total Results

  Total number of submitted forms that match the request.

{
    "description":"The collection of associated submitted forms that are registered for the activity. ",
    "properties":{
        "items":{
            "items":{
                "$ref":"#/definitions/submittedForm"
            },
            "type":"array",
            "description":"The collection of associated submitted forms that are registered for the activity.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request.",
            "title":"Offset"
        },
        "limit":{
            "type":"integer",
            "description":"The limit value specified in the request (May be different form specified in the request parameter).",
            "title":"Limit"
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of submitted forms that match the request.",
            "title":"Total Results"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then there are more results that can be retrieved with successive paging requests. If false or if the value is not present, then there are no more results or this is the final page. The default value is true.",
            "title":"Has More Results"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of associated submitted forms that are registered for the activity.

Show Source

• Array of: object submittedForm
  Associated submitted form to the activity.

{
    "items":{
        "$ref":"#/definitions/submittedForm"
    },
    "type":"array",
    "description":"The collection of associated submitted forms that are registered for the activity.",
    "title":"Items"
}

Nested Schema : submittedForm

Type: object

Associated submitted form to the activity.

Show Source

• activityDetails: object Form activity details
  Title: Form activity details

  This object will contain activity fields that can be submitted with a particular form.
• bundles: array Bundle Labels
  Title: Bundle Labels

  List of the labels of the configured bundles to which the submitted form is related. This value is not present if the request parameter "scope" is "activity"
• formDetails: object Form details
  Title: Form details

  This object will contain the fields that can be submitted with a particular form.
• formIdentifier: object Form identifier
  Title: Form identifier

  Label of the form and unique id of the submitted form.
• time: string
  Title: Time

  The datetime in UTC when the form was submitted. For example, 2016-04-25 12:36:11.
• user: string
  Title: User

  The user identifier (login) of the user who submitted the form.

{
    "type":"object",
    "description":"Associated submitted form to the activity.",
    "properties":{
        "formIdentifier":{
            "type":"object",
            "title":"Form identifier",
            "description":"Label of the form and unique id of the submitted form.",
            "properties":{
                "formSubmitId":{
                    "type":"integer",
                    "title":"Form submit ID",
                    "description":"Unique id of the submitted form"
                },
                "formLabel":{
                    "type":"string",
                    "title":"Form Label",
                    "description":"The label of the submitted form"
                }
            }
        },
        "user":{
            "type":"string",
            "description":"The user identifier (login) of the user who submitted the form.",
            "title":"User"
        },
        "time":{
            "type":"string",
            "description":"The datetime in UTC when the form was submitted. For example, 2016-04-25 12:36:11.",
            "title":"Time"
        },
        "bundles":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "title":"Bundle Labels",
            "description":"List of the labels of the configured bundles to which the submitted form is related. This value is not present if the request parameter \"scope\" is \"activity\""
        },
        "formDetails":{
            "$ref":"#/definitions/formDetails"
        },
        "activityDetails":{
            "$ref":"#/definitions/formActivityDetails"
        }
    }
}

Nested Schema : Form activity details

Type: object

Title: Form activity details

This object will contain activity fields that can be submitted with a particular form.

Nested Schema : Bundle Labels

Type: array

Title: Bundle Labels

List of the labels of the configured bundles to which the submitted form is related. This value is not present if the request parameter "scope" is "activity"

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "title":"Bundle Labels",
    "description":"List of the labels of the configured bundles to which the submitted form is related. This value is not present if the request parameter \"scope\" is \"activity\""
}

Nested Schema : Form details

Type: object

Title: Form details

This object will contain the fields that can be submitted with a particular form.

Nested Schema : Form identifier

Type: object

Title: Form identifier

Label of the form and unique id of the submitted form.

Show Source

• formLabel: string
  Title: Form Label

  The label of the submitted form
• formSubmitId: integer
  Title: Form submit ID

  Unique id of the submitted form

{
    "type":"object",
    "title":"Form identifier",
    "description":"Label of the form and unique id of the submitted form.",
    "properties":{
        "formSubmitId":{
            "type":"integer",
            "title":"Form submit ID",
            "description":"Unique id of the submitted form"
        },
        "formLabel":{
            "type":"string",
            "title":"Form Label",
            "description":"The label of the submitted form"
        }
    }
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top