script_questions.md

layout	title
default	Scripts

Script Question

This page defines the Script Question resource.

Scripts Questions are intermediary resources that associate Questions with Scripts.

Note: When putting or creating Script Question resources, it is up to the server to validate or return errors when problems with sequence arises.

Sections

• Endpoints and URL structures
• Fields
  • Common Fields
  • Script Fields
  • Links
• Related Resources
• Scenarios
  • Scenario: Retrieving a collection of Script Question resources (GET)
  • Scenario: Retrieving an individual Script Question resource (GET)
  • Scenario: Add a script question to the script (POST)
  • Scenario: Update a script question for the script (PUT)
  • Scenario: Delete a script question from the script (DELETE)

{% include endpoints_and_url_structures.md %}

The link relation label for a Script Question resource is osdi:script_question for a single Script resource or osdi:script_questions for a collection of Script Question resources.

Back to top...

Fields

{% include fields_intro.md %}

{% include global_fields.md %}

Back to top...

Script Fields

Name	Type	Description
sequence	int	A sequence number for the Scipt Question. Defines the position of the linked question in a script.

Back to top...

Links

{% include links_intro.md %}

Name	Type	Description
question	Question*	A link to the associated Question resources for this Script Question.

Back to top...

Related Resources

• Script
• Question

Back to top...

Scenarios

{% include scenarios_intro.md %}

Scenario: Retrieving a collection of Script Question resources (GET)

Script Question resources can be retrieved as a collection of script questions for a specific script. Calling the script questions endpoint will return a collection of all the script questions associated with the script accessible with your api key.

Request

GET https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions

Header:
OSDI-API-Token:[your api key here]

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "total_pages": 10,
    "per_page": 25,
    "page": 1,
    "total_records": 250,
    "_links": {
        "next": {
            "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions?page=2"
        },
        "osdi:script_questions": [
            {
                "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions/ae0e-4cd3-9ed7-d0"
            },
            {
                "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions/be0e-4cd3-9ed7-d0"
            },
            // truncated for brevity
        ],
        "curies": [
            {
                "name": "osdi",
                "href": "https://osdi-sample-system.org/docs/v1/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions
        }
    },
    "_embedded": {
        "osdi:scipt_questions": [
            {
                "identifiers": [
                    "osdi_sample_system:ae0e-4cd3-9ed7-d0",
                    "foreign_system:1"
                ],
                "origin_system": "OSDI Sample System",
                "created_date": "2014-03-20T21:04:31Z",
                "modified_date": "2014-03-20T21:04:31Z",
                "sequence": 1,
                "_links": {
                    "curies": [
                        {
                            "name": "osdi",
                            "href": "https://osdi-sample-system.org/docs/v1/{rel}",
                            "templated": true
                        }
                    ],
                    "self": {
                        "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions/ae0e-4cd3-9ed7-d0"
                    },
                    "osdi:question": {
                        "href": "http://osdi-sample-system.org/api/v1/questions/202004"
                    },
                    "osdi:script": {
                        "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3"
                    }
                },
                "_embedded": {
                    "osdi:question": {
                        "origin_system": "OSDISystem",
                        "name": "foobar",
                        "description": "What is your name?",
                        "title": "foobar",
                        "summary": "What is your name?",
                        "question_type": "SingleChoice",
                        "identifiers": [
                            "OSDISystem:202004"
                        ],
                        "_links": {
                            "self": {
                                "href": "http://osdi-sample-system.org/api/v1/questions/202004"
                            },
                            "curies": [
                                {
                                    "name": "osdi",
                                    "href": "http://osdi-sample-system.org/osdi#{rel}",
                                    "templated": true
                                }
                            ]
                        }
                    }
                }
            },
            {
                "identifiers": [
                    "osdi_sample_system:be0e-4cd3-9ed7-d0",
                    "foreign_system:2"
                ],
                "origin_system": "OSDI Sample System",
                "created_date": "2014-03-20T21:04:31Z",
                "modified_date": "2014-03-20T21:04:31Z",
                "sequence": 2,
                "_links": {
                    "curies": [
                        {
                            "name": "osdi",
                            "href": "https://osdi-sample-system.org/docs/v1/{rel}",
                            "templated": true
                        }
                    ],
                    "self": {
                        "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions/be0e-4cd3-9ed7-d0"
                    },
                    "osdi:question": {
                        "href": "http://osdi-sample-system.org/api/v1/questions/203079"
                    },
                    "osdi:script": {
                        "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3"
                    }
                },
                "_embedded": {
                    "osdi:question": {
                        "origin_system": "OSDISystem",
                        "name": "pbank",
                        "description": "Will you phone bank?",
                        "title": "pbank",
                        "summary": "Will you phone bank?",
                        "question_type": "SingleChoice",
                        "responses": [
                            {
                                "key": "856278",
                                "name": "Yes",
                                "title": "Yes"
                            },
                            {
                                "key": "856279",
                                "name": "No",
                                "title": "No"
                            }
                        ],
                        "identifiers": [
                            "OSDISystem:203079"
                        ],
                        "_links": {
                            "self": {
                              "href": "http://osdi-sample-system.org/api/v1/questions/203079"
                            },
                            "curies": [
                                {
                                    "name": "osdi",
                                    "href": "http://osdi-sample-system.org/osdi#{rel}",
                                    "templated": true
                                }
                            ]
                        }
                    }
               }
            },
            // truncated for brevity
        ]
    }
}

Back to top...

Scenario: Retrieving an individual Script Question resource (GET)

Calling an individual Script Question resource will return the resource directly, along with all associated fields, embedded Questions and appropriate links to additional information about the script question.

Request

GET https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions/ae0e-4cd3-9ed7-d0

Header:
OSDI-API-Token:[your api key here]

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "identifiers": [
        "osdi_sample_system:ae0e-4cd3-9ed7-d0",
        "foreign_system:1"
    ],
    "origin_system": "OSDI Sample System",
    "created_date": "2014-03-20T21:04:31Z",
    "modified_date": "2014-03-20T21:04:31Z",
    "sequence": 1,
    "_links": {
        "curies": [
            {
                "name": "osdi",
                "href": "https://osdi-sample-system.org/docs/v1/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions/ae0e-4cd3-9ed7-d0"
        },
        "osdi:question": {
            "href": "http://osdi-sample-system.org/api/v1/questions/202004"
        },
        "osdi:script": {
            "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3"
        }
    },
    "_embedded": {
        "osdi:question": {
            "origin_system": "OSDISystem",
            "name": "foobar",
            "description": "What is your name?",
            "title": "foobar",
            "summary": "What is your name?",
            "question_type": "SingleChoice",
            "identifiers": [
                "OSDISystem:202004"
            ],
            "_links": {
                "self": {
                    "href": "http://osdi-sample-system.org/api/v1/questions/202004"
                },
                "curies": [
                    {
                        "name": "osdi",
                        "href": "http://osdi-sample-system.org/osdi#{rel}",
                        "templated": true
                    }
                ]
            }
        }
    }
}

Back to top...

Scenario: Add a script question to the script (POST)

Posting to the script questions collection endpoint will allow you to add a new question to an existing script.

Request

POST https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions

Header:
OSDI-API-Token:[your api key here]

{
    "sequence": 1,
    "_links" : {
        "osdi:question" : "http://osdi-sample-system.org/api/v1/questions/52472"
    }
}

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate
{
    "identifiers": [
        "osdi_sample_system:ae0e-4cd3-9ed7-d0"
    ],
    "origin_system": "OSDI Sample System",
    "created_date": "2014-03-20T21:04:31Z",
    "modified_date": "2014-03-20T21:04:31Z",
    "sequence": 1,
    "origin_system": "OSDISystem",
    "_links": {
        "curies": [
            {
                "name": "osdi",
                "href": "https://osdi-sample-system.org/docs/v1/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions/ae0e-4cd3-9ed7-d0"
        },
        "osdi:question": {
            "href": "http://osdi-sample-system.org/api/v1/questions/202004"
        },
        "osdi:script": {
            "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3"
        }
    },
    "_embedded": {
        "osdi:question": {
            "origin_system": "OSDISystem",
            "name": "foobar",
            "description": "What is your name?",
            "title": "foobar",
            "summary": "What is your name?",
            "question_type": "SingleChoice",
            "identifiers": [
                "OSDISystem:202004"
            ],
            "_links": {
                "self": {
                    "href": "http://osdi-sample-system.org/api/v1/questions/202004"
                },
                "curies": [
                    {
                        "name": "osdi",
                        "href": "http://osdi-sample-system.org/osdi#{rel}",
                        "templated": true
                    }
                ]
            }
        }
    }
}
    

Scenario: Update a script question for the script (PUT)

Calling a PUT request on a script question endpoint will allow you to update a script question for the script.

Request

POST https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions/ae0e-4cd3-9ed7-d0

Header:
OSDI-API-Token:[your api key here]

{
    "sequence": 2,
}

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate
{
    "identifiers": [
        "osdi_sample_system:ae0e-4cd3-9ed7-d0"
    ],
    "origin_system": "OSDI Sample System",
    "created_date": "2014-03-20T21:04:31Z",
    "modified_date": "2014-03-20T21:04:31Z",
    "sequence": 2,
    "origin_system": "OSDISystem",
    "_links": {
        "curies": [
            {
                "name": "osdi",
                "href": "https://osdi-sample-system.org/docs/v1/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3/script_questions/ae0e-4cd3-9ed7-d0"
        },
        "osdi:question": {
            "href": "http://osdi-sample-system.org/api/v1/questions/202004"
        },
        "osdi:script": {
            "href": "https://osdi-sample-system.org/api/v1/scripts/d91b4b2e-ae0e-4cd3-9ed7-d0ecb0bc3"
        }
    },
    "_embedded": {
        "osdi:question": {
            "origin_system": "OSDISystem",
            "name": "foobar",
            "description": "What is your name?",
            "title": "foobar",
            "summary": "What is your name?",
            "question_type": "SingleChoice",
            "identifiers": [
                "OSDISystem:202004"
            ],
            "_links": {
                "self": {
                    "href": "http://osdi-sample-system.org/api/v1/questions/202004"
                },
                "curies": [
                    {
                        "name": "osdi",
                        "href": "http://osdi-sample-system.org/osdi#{rel}",
                        "templated": true
                    }
                ]
            }
        }
    }
}

Back to top...

Scenario: Delete a script question from the script (DELETE)

You may delete a script question from the script by calling the DELETE command on the script question endpoint.

Request

DELETE https://osdi-sample-system.org/api/v1/scripts/d32fcdd6-7366-466d-a3b8-7e0d87c3cd8b/script_questions/ae0e-4cd3-9ed7-d0

Header:
OSDI-API-Token:[your api key here]

Response

200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate

{
    "notice": "Script Question was deleted from the script."
}

Back to top...